Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork63
python/docsbuild-scripts
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
This repository contains scripts for automatically building the Pythondocumentation ondocs.python.org.
The following command should build all maintained versions andtranslations 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.
Installtools_requirements.txt then runpython check_versions.py ../cpython/ (pointing to a real CPython clone) to see which versionof Sphinx we're using where:
Sphinx configuration in various branches:========= ============= ================== ====================version travis requirements.txt conf.py========= ============= ================== ====================2.7 sphinx~=2.0.1 ø needs_sphinx='1.2'3.5 sphinx==1.8.2 ø needs_sphinx='1.8'3.6 sphinx==1.8.2 ø needs_sphinx='1.2'3.7 sphinx==1.8.2 sphinx==2.3.1 needs_sphinx="1.6.6"3.8 ø sphinx==2.4.4 needs_sphinx='1.8'3.9 ø sphinx==2.4.4 needs_sphinx='1.8'3.10 ø sphinx==3.4.3 needs_sphinx='3.2'3.11 ø sphinx~=7.2.0 needs_sphinx='4.2'3.12 ø sphinx~=8.2.0 needs_sphinx='8.2.0'3.13 ø sphinx~=8.2.0 needs_sphinx='8.2.0'3.14 ø sphinx~=8.2.0 needs_sphinx='8.2.0'========= ============= ================== ====================Sphinx build as seen on docs.python.org:========= ===== ===== ===== ===== ===== ===== ===== ===== ======= ===== ===== ======= =======version en es fr id it ja ko pl pt-br tr uk zh-cn zh-tw========= ===== ===== ===== ===== ===== ===== ===== ===== ======= ===== ===== ======= =======3.9 2.4.4 2.4.4 2.4.4 2.4.4 2.4.4 2.4.4 2.4.4 2.4.4 2.4.4 2.4.4 2.4.4 2.4.4 2.4.43.10 3.4.3 3.4.3 3.4.3 3.4.3 3.4.3 3.4.3 3.4.3 3.4.3 3.4.3 3.4.3 3.4.3 3.4.3 3.4.33.11 7.2.6 7.2.6 7.2.6 7.2.6 7.2.6 7.2.6 7.2.6 7.2.6 7.2.6 7.2.6 7.2.6 7.2.6 7.2.63.12 8.2.3 8.2.3 8.2.3 8.2.3 8.2.3 8.2.3 8.2.3 8.2.3 8.2.3 8.2.3 8.2.3 8.2.3 8.2.33.13 8.2.3 8.2.3 8.2.3 8.2.3 8.2.3 8.2.3 8.2.3 8.2.3 8.2.3 8.2.3 8.2.3 8.2.3 8.2.33.14 8.2.3 8.2.3 8.2.3 8.2.3 8.2.3 8.2.3 8.2.3 8.2.3 8.2.3 8.2.3 8.2.3 8.2.3 8.2.3========= ===== ===== ===== ===== ===== ===== ===== ===== ======= ===== ===== ======= =======Docs forfeature and bugfix branches areautomatically 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.iosudo su --shell=/bin/bash docsbuildscreen -DUR# Rejoin screen session if it exists, otherwise create a new one/srv/docsbuild/venv/bin/python /srv/docsbuild/scripts/build_docs.py --force --branch 3.11About
scripts for building documentation on docs.python.org
Resources
Code of conduct
Security policy
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Releases
Sponsor this project
Uh oh!
There was an error while loading.Please reload this page.
Packages0
Uh oh!
There was an error while loading.Please reload this page.