GH-125722: Use long options for Sphinx (GH-129039)
(cherry picked from commit 4967fa6a9c)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Doc: Fix archive filenames for standard builds (GH-124826)
(cherry picked from commit 91e64be731)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Doc: Run HTML and non-HTML daily builds separately (GH-124493)
(cherry picked from commit cce1125574)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
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`.
(cherry picked from commit 9a6e2336e4)
Co-authored-by: Zachary Ware <zach@python.org>
Fix doctrees directory for the gettext builder (GH-122997)
(cherry picked from commit 315a933a5b)
Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
Doc: Add ``make dist-no-html`` (GH-124383)
(cherry picked from commit 0060486862)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Docs: Run ``latexmk`` in parallel when creating PDFs (GH-123113)
(cherry picked from commit 79c542b5cc)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* 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>
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
[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
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.
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
