Julien Palard
b9735420aa
bpo-42238: Check Misc/NEWS.d/next/ for reStructuredText issues. (GH-23802)
2020-12-18 10:48:08 +01:00
Julien Palard
c9c6e9f89a
bpo-42238: Doc: Remove make suspicious from the CI and docs builds. (GH-23313)
...
It probably helped a lot a while back, but may not be as usefull
today. We'll continue monitoring it before deletion, so true
positives can be migrated to rstlint.
2020-11-25 10:18:00 +01:00
Julien Palard
ee2549c2ba
bpo-41028: Doc: Move switchers to docsbuild-scripts. (GH-20969)
2020-11-07 12:28:31 +01:00
Victor Stinner
8394500cca
bpo-35293: Travis CI uses "make venv" for the doc (GH-22307)
...
Doc/requirements.txt becomes the reference for packages and package
versions needed to build the Python documentation.
* Doc/Makefile now uses Doc/requirements.txt
* .travis.yml now uses "make env" of Doc/Makefile
2020-09-18 16:23:18 +02:00
Victor Stinner
51fece1bb8
bpo-41685: Don't pin setuptools version anymore in Doc/Makefile (GH-22062)
...
setuptools 50.0.2 is now compatible with Python 3.10:
https://github.com/pypa/setuptools/pull/2361
2020-09-02 13:11:21 +02:00
Victor Stinner
c0d5c131d9
bpo-40204: Update Sphinx to version 3.2.1 in Doc/Makefile (GH-22043)
2020-09-02 12:29:31 +02:00
Ned Deily
a4c4e17f95
bpo-41685: Temporarily pin setuptools to 49.2.1 in Docs venv. (GH-22038)
...
See https://github.com/pypa/setuptools/pull/2361
2020-09-01 05:40:27 -04:00
Ned Deily
589e8fe079
bpo-40204: Pin Sphinx version to 2.3.1 in `Doc/Makefile`. (GH-21141)
2020-06-25 07:22:10 -04:00
Julien Palard
c987090c73
Bump Sphinx to 2.2.0. (GH-16532)
2019-10-22 18:13:41 +02:00
Dmitry Shachnev
c3d679fd39
bpo-37504: Fix documentation build with texinfo builder (GH-14606)
...
In the table model used by docutils, the `cols` attribute of `tgroup`
nodes is mandatory, see [1]. It is used in texinfo builder in [2].
[1]: https://www.oasis-open.org/specs/tm9901.htm#AEN348
[2]: https://github.com/sphinx-doc/sphinx/blob/v2.1.2/sphinx/writers/texinfo.py#L1129
* Doc: Add texinfo support to the Makefile
2019-09-10 15:40:50 +01:00
Jean-François B
b5381f6697
bpo-34293: Fix PDF documentation paper size (GH-8585)
...
The "A4" pdfs were previously the wrong size due to a change in the options in Sphinx 1.5.
See also sphinx-doc/sphinx#5235
2019-09-09 22:52:03 +01:00
Julien Palard
7d23dbe6d1
Doc: Bump Sphinx verison. ( #13785 )
...
To reflect the one we're using in production.
2019-06-15 15:41:58 +02:00
Stéphane Wirtel
0a52d73dde
Doc: Update pip and setuptools when creating the virtual environment (GH-13307)
...
Add a new pip install before `sphinx` etc.. because we should use the last version of `pip` and `setuptools`
2019-05-14 04:49:49 -07:00
Gregory P. Smith
3918ad6b45
bpo-36838: Suggest 'make venv' when missing Doc/ tools. (GH-13173)
2019-05-07 17:03:50 -04:00
Stéphane Wirtel
09a9f1799c
bpo-36329: Declare the version of Python to use for Tools/scripts/serve.py ( #12385 )
...
* bpo-36329: Declare the version of Python to use for Tools/scripts/serve.py
* Add the blurb entry
2019-03-18 11:47:55 +01:00
Julien Palard
f98c1623ec
Doc: -W flag for sphinx-build can be disabled (GH-10303)
2018-11-03 19:06:33 +01:00
Xtreak
121eb1694c
bpo-34081: Fix wrong example link that was linking to distutils (GH-8248)
2018-10-21 16:54:52 +02:00
Jon Wayne Parrott
bf63e8d55f
bpo-30607: Use external python-doc-theme (GH-2017)
2018-03-01 16:02:50 -05:00
Ned Deily
122fc136b3
Revert "bpo-30487: automatically create a venv and install Sphinx when running make (GH-4346)" ( #4592 )
...
Fix breakage documented in bpo-32149.
This reverts commit d8d6b91221
2017-11-27 17:07:32 -05:00
Caleb Hattingh
d8d6b91221
bpo-30487: automatically create a venv and install Sphinx when running make (GH-4346)
2017-11-26 15:18:30 -06:00
Ned Deily
590665c399
bpo-31036: Allow sphinx and blurb to be found automatically ( #3440 )
...
Rather than requiring the path to blurb and/or sphinx-build to be specified to the make rule, enhance the Doc/Makefile to look for each first in a virtual environment created by make venv and, if not found, look on the normal process PATH. This allows the Doc/Makefile to take advantage of an installed spinx-build or blurb and, thus, do the right thing most of the time. Also, make the directory for the venv be configurable and document the `make venv` target.
2017-09-07 17:17:53 -07:00
Ned Deily
fcd97d4438
Include additional changes to support blurbified NEWS ( #3340 )
2017-09-05 00:46:18 -07:00
Julien
dff9b5f9d6
bpo-31045: Language switch ( #2652 )
...
* Doc: Indicate the language
* Renaming version_switcher to switchers (to add language_switcher).
* Adding language switch.
* Doc switchers: Enhance readability of regex parsing versions.
* Doc switchers: Desambiguate the need of a replace(/\/+$/g, '') by proper naming.
* Doc switchers: py3k can't reach js, it's redirected server-side by nginx.
* Doc switchers: Examples matching actual regexes.
* Doc switchers: Better fallback on unexisting translated version.
2017-08-07 10:27:21 +02:00
Nick Coghlan
7a82f9c2b9
bpo-30052: Always regenerate cross-references ( #1339 )
...
* bpo-30052: Always regenerate cross-references
The patch for bpo-30052 changed the preferred link target
for :func:`bytes` and :func`bytearray` references to be the
respective type definitions rather than the corresponding
builtin function entries.
This patch changes the daily documentation builds to disable
the output caching in Sphinx, in order to ensure that
cross-reference changes like this one are reliably picked
up and applied automatically after merging.
2017-06-02 23:30:57 +10:00
Roger
b3f1f59cf4
Rename Doc/README.txt to Doc/README.rst and add formatting ( #104 )
...
* Reformat Doc/README.txt to Doc/README.rst
* Update mention of Doc/README.rst
* Update mention of README.txt to README.rst
* Make line fold
* rstlint ignore Doc/README.rst
* conf.py ignore Doc/README.rst
* Update issue tracker url in Docs/README.rst
2017-02-15 23:54:05 +01:00
