@@ -2,7 +2,7 @@ This repository contains scripts for automatically building the Python
22documentation on[ docs.python.org] ( https://docs.python.org ) .
33
44
5- #How to test it?
5+ ## How to test it?
66
77The following command should build all maintained versions and
88translations in` ./www ` , beware it can take a few hours:
@@ -15,7 +15,7 @@ If you don't need to build all translations of all branches, add
1515` --language en --branch main ` .
1616
1717
18- #Check current version
18+ ## Check current version
1919
2020Install` tools_requirements.txt ` then run `python check_versions.py
2121../cpython/` (pointing to a real CPython clone) to see which version
@@ -51,3 +51,20 @@ of Sphinx we're using where:
51513.13 8.1.3 8.1.3 8.1.3 8.1.3 8.1.3 8.1.3 8.1.3 8.1.3 8.1.3 8.1.3 8.1.3 8.1.3 8.1.3
52523.14 8.1.3 8.1.3 8.1.3 8.1.3 8.1.3 8.1.3 8.1.3 8.1.3 8.1.3 8.1.3 8.1.3 8.1.3 8.1.3
5353========= ===== ===== ===== ===== ===== ===== ===== ===== ======= ===== ===== ======= =======
54+
55+ ##Manually rebuild a branch
56+
57+ Docs for[ feature and bugfix branches] ( https://devguide.python.org/versions/ ) are
58+ automatically built from a cron.
59+
60+ Manual rebuilds are needed for new security releases,
61+ and to add the end-of-life banner for newly end-of-life branches.
62+
63+ To manually rebuild a branch, for example 3.11:
64+
65+ ``` shell
66+ ssh docs.nyc1.psf.io
67+ sudo su --shell=/bin/bash docsbuild
68+ screen -DUR# Rejoin screen session if it exists, otherwise create a new one
69+ /srv/docsbuild/venv/bin/python /srv/docsbuild/scripts/build_docs.py --branch 3.11
70+ ```