9a6e2336e4
Fix `make htmllive` target (GH-124219)
...
Allow `make -C Doc htmllive` to work without manual venv activation
Set PATH to ensure that `sphinx-autobuild` can find `sphinx-build`.
2024-09-18 21:02:20 +00:00
f5597dbd0e
Docs: Drop letter PDF ( #123912 )
2024-09-12 13:49:19 +03:00
b178beef26
Docs: Fix Makefile syntax ( #123287 )
2024-08-24 12:57:38 +00:00
79c542b5cc
Docs: Run ``latexmk`` in parallel when creating PDFs ( #123113 )
2024-08-17 20:58:06 +00:00
315a933a5b
Fix doctrees directory for the gettext builder ( #122997 )
2024-08-14 11:38:29 +01:00
f5c39b3e9c
gh-122661: Remove GNU make-specific directive from Doc/Makefile ( #122662 )
2024-08-04 17:02:29 +03:00
bc37ac7b44
Docs makefile/RTD: Use uv if installed ( #120711 )
2024-06-23 13:23:27 -06:00
88e3fee3f8
Docs: Only install sphinx-autobuild for `make htmllive` ( #119607 )
2024-05-27 11:29:27 -06:00
fb0cf7d140
gh-119009: Add gettext target ( #119006 )
2024-05-15 12:13:52 -06:00
332ac46c09
docs: announce venv creation before installing packages ( #117036 )
2024-03-19 21:55:20 +02:00
36adc79041
Docs: make htmllive: open browser when ready ( #113288 )
2023-12-26 05:02:13 -07:00
a430b4ffdd
Docs: Add `make htmllive` to rebuild and reload HTML files in your browser ( #111900 )
2023-11-13 10:06:49 +02:00
bdbe43c7d0
Remove unused `SPHINXLINT` var from `Doc/Makefile`. ( #110570 )
...
Remove unused `SPHINXLINT` var.
2023-10-10 00:30:23 +02:00
bc07c8f096
Docs: move sphinx-lint to pre-commit ( #105750 )
2023-06-18 11:52:05 +00:00
44b5c21f41
GH-103903: Test the minimum Sphinx version in CI ( #103904 )
2023-04-27 19:27:38 +01:00
1a62ae84c6
Add JOBS parameter to docs Makefile ( #101395 )
2023-01-31 15:29:29 +02:00
969620d59a
Docs: Move .PHONY to each section to avoid copy/paste omissions ( #99396 )
2022-11-27 19:48:29 +02:00
4414586172
Mark all targets in `Doc/Makefile` as `PHONY` (GH-98189)
2022-10-12 21:40:47 +02:00
4067c6d7fe
gh-86404: Doc: Drop now unused make suspicious and rstlint. (GH-98179)
...
They have been replaced by
[sphinx-lint](https://github.com/sphinx-contrib/sphinx-lint ).
2022-10-11 15:31:33 +02:00
a487623c6b
Speedup: build docs in parallel (GH-92733)
2022-05-16 13:52:00 +02:00
953ab07952
Restore default role check in `make check`. ( #92290 )
...
* Restore default role check in `make check`.
* Options first, then files.
* Update `make.bat` too.
* Add a comment explaining the extra options.
* No reason to ignore the README.rst.
* Enable default-role check in sphinx-lint.
Co-authored-by: Julien Palard <julien@palard.fr>
* Update sphinx-lint default-role check.
* Fix use of the default role in the docs.
* Update make.bat to check for the default role too.
* Fix comment in make.bat.
Co-authored-by: Julien Palard <julien@palard.fr>
2022-05-15 17:34:52 +02:00
89c6b2b8f6
bpo-36329: Remove 'make -C Doc serve' in favour of 'make -C Doc htmlview' (GH-32354)
...
Also updated `make -C htmlview` so it used a full path with `file://`, because the original didn't open the page (macOS).
For example:
```sh
cd Doc
# Doesn't open anything:
python3 -c "import webbrowser; webbrowser.open('build/html/index.html')"
# Opens the docs page e.g. file:///Users/hugo/github/cpython/Doc/build/html/index.html :
python3 -c "import os, webbrowser; webbrowser.open('file://' + os.path.realpath('build/html/index.html'))"
```
https://bugs.python.org/issue36329
2022-04-29 15:47:26 +02:00
b878b3af0b
bpo-42238: [doc] moving from rstlint.py to sphinx-lint. (GH-31097)
2022-02-10 08:59:04 +01:00
f1e29cea85
Allows to specify the port on which serve documentation (GH-31145)
...
[user@localhost]$ make serve # default configuration, no change
python3 ../Tools/scripts/serve.py build/html
Serving build/html on port 8000, control-C to stop
^CShutting down.
[user@localhost]$ make serve SERVE_PORT=8080 # new option
python3 ../Tools/scripts/serve.py build/html 8080
Serving build/html on port 8080, control-C to stop
2022-02-06 11:22:06 +01:00
024209401e
bpo-42238: [doc] Announce the future removal of make suspicous. (GH-29652)
...
* bpo-42238: [doc] Announce the future removal of make suspicous.
* Add a news entry.
2021-11-22 15:17:54 -08:00
55fa87b1ef
bpo-44756: [docs] revert automated virtual environment creation on `make html` (GH-27635)
...
It turned out to be disruptive for downstream distributors.
2021-08-06 20:13:59 +02:00
d22c876d5a
bpo-44756: in ./Doc, `make build` depends on `make html` ( #27403 )
...
- venv rule is now conditional, and only does anything if $VENVDIR does not exist
- add rule "clean-venv"
2021-07-28 15:13:28 +02:00
b9735420aa
bpo-42238: Check Misc/NEWS.d/next/ for reStructuredText issues. (GH-23802)
2020-12-18 10:48:08 +01:00
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
ee2549c2ba
bpo-41028: Doc: Move switchers to docsbuild-scripts. (GH-20969)
2020-11-07 12:28:31 +01:00
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
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
c0d5c131d9
bpo-40204: Update Sphinx to version 3.2.1 in Doc/Makefile (GH-22043)
2020-09-02 12:29:31 +02:00
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
589e8fe079
bpo-40204: Pin Sphinx version to 2.3.1 in ``Doc/Makefile``. (GH-21141)
2020-06-25 07:22:10 -04:00
c987090c73
Bump Sphinx to 2.2.0. (GH-16532)
2019-10-22 18:13:41 +02:00
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
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
7d23dbe6d1
Doc: Bump Sphinx verison. ( #13785 )
...
To reflect the one we're using in production.
2019-06-15 15:41:58 +02:00
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
3918ad6b45
bpo-36838: Suggest 'make venv' when missing Doc/ tools. (GH-13173)
2019-05-07 17:03:50 -04:00
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
f98c1623ec
Doc: -W flag for sphinx-build can be disabled (GH-10303)
2018-11-03 19:06:33 +01:00
121eb1694c
bpo-34081: Fix wrong example link that was linking to distutils (GH-8248)
2018-10-21 16:54:52 +02:00
bf63e8d55f
bpo-30607: Use external python-doc-theme (GH-2017)
2018-03-01 16:02:50 -05:00
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
d8d6b91221
bpo-30487: automatically create a venv and install Sphinx when running make (GH-4346)
2017-11-26 15:18:30 -06:00
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
fcd97d4438
Include additional changes to support blurbified NEWS ( #3340 )
2017-09-05 00:46:18 -07:00
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
Zachary Ware
Hugo van Kemenade
Adam Turner
Rafael Fontenelle
Libor Martínek
Ned Batchelder
Hugo van Kemenade
Ezio Melotti
Christophe Nanteuil
Nikita Sobolev
Julien Palard
Łukasz Langa
Jack DeVries
Victor Stinner
Ned Deily
Dmitry Shachnev
Jean-François B
Stéphane Wirtel
Gregory P. Smith
Xtreak
Jon Wayne Parrott
Caleb Hattingh
Julien