This repository contains scripts for automatically building the Python documentation on docs.python.org.

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-invalidation

If you don't need to build all translations of all branches, add --languages en --branches main.

Sphinx configuration in various branches:

Sphinx build as seen on docs.python.org:

Install 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.

Docs for feature and bugfix branches are automatically built from a cron. Security branches are also built from a cron (the crons passing --include-security-branches), but less frequently.

Manual rebuilds are needed 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