This repository contains scripts for automatically building the Python documentation on
.
How to test it?
The following command should build all maintained versions and translations in ./www, beware it can take a few hours:
python3 ./build_docs.py --quick --build-root ./build_root --www-root ./www --log-directory ./logs --group $(id -g) --skip-cache-invalidationIf you don't need to build all translations of all branches, add --languages en --branches main.
Sphinx versions
Sphinx configuration in various branches:
versionrequirements.txtconf.py2.6øø2.7øneeds_sphinx='1.2'3.0øø3.1øø3.2øø3.3øø3.4øneeds_sphinx='1.2'3.5øneeds_sphinx='1.8'3.6øneeds_sphinx='1.2'3.7sphinx==2.3.1needs_sphinx='1.6.6'3.8sphinx==2.4.4needs_sphinx='1.8'3.9sphinx==2.4.4needs_sphinx='1.8'3.10sphinx==3.4.3needs_sphinx='3.2'3.11sphinx~=7.2.0needs_sphinx='4.2'3.12sphinx~=8.2.0needs_sphinx='8.2.0'3.13sphinx~=8.2.0needs_sphinx='8.2.0'3.14sphinx~=8.2.0needs_sphinx='8.2.0'3.15sphinx~=8.2.0needs_sphinx='8.2.0'Sphinx build as seen on docs.python.org:
versionelenesfrbn-iniditjakoplpt-brrosvtrukzh-cnzh-tw2.6ø0.6.5øøøøøøøøøøøøøøø2.7ø2.3.1ø2.3.1ø2.3.1ø2.3.12.3.1ø2.3.1øøøø2.3.12.3.13.0ø0.6øøøøøøøøøøøøøøø3.1ø0.6.5øøøøøøøøøøøøøøø3.2ø1.0.7øøøøøøøøøøøøøøø3.3ø1.2øøøøøøøøøøøøøøø3.4ø1.2.3øøøøøøøøøøøøøøø3.5ø1.8.41.8.41.8.4ø1.8.4ø1.8.41.8.41.8.41.8.4øøøø1.8.41.8.43.6ø2.3.12.3.12.3.1ø2.3.1ø2.3.12.3.12.3.12.3.1øøøø2.3.12.3.13.7ø2.3.12.3.12.3.1ø2.3.12.3.12.3.12.3.12.3.12.3.1øø2.3.12.3.12.3.12.3.13.8ø2.4.42.4.42.4.4ø2.4.42.4.42.4.42.4.42.4.42.4.4øø2.4.42.4.42.4.42.4.43.92.4.42.4.42.4.42.4.42.4.42.4.42.4.42.4.42.4.42.4.42.4.42.4.4ø2.4.42.4.42.4.42.4.43.103.4.33.4.33.4.33.4.33.4.33.4.33.4.33.4.33.4.33.4.33.4.33.4.3ø3.4.33.4.33.4.33.4.33.117.2.67.2.67.2.67.2.67.2.67.2.67.2.67.2.67.2.67.2.67.2.67.2.6ø7.2.67.2.67.2.67.2.63.128.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.3ø8.2.38.2.38.2.38.2.33.138.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.33.148.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.33.158.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.3Install tools_requirements.txt then run python check_versions.py ../cpython/ (pointing to a real CPython clone) to see which versions of Sphinx we're using.
Or run tox -e cog (with a clone at ../cpython) to directly update these tables.
Manually rebuild a branch
Docs for
are automatically built from a cron.
Manual rebuilds are needed for new security releases, and to add the end-of-life banner for newly end-of-life branches.
To manually rebuild a branch, for example 3.11:
ssh docs.nyc1.psf.io sudo su --shell=/bin/bash docsbuild screen -DUR # Rejoin screen session if it exists, otherwise create a new one /srv/docsbuild/venv/bin/python /srv/docsbuild/scripts/build_docs.py --force --branches 3.11