GitHub - ConnectionMaster/docsbuild-scripts: scripts for building documentation on docs.python.org
This repository contains scripts for automatically building the Python documentation on docs.python.org.
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-invalidation
If you don't need to build all translations of all branches, add
--language en --branch master.
Check current version
Install tools-requirements.txt then run python check_versions.py ../cpython/ (pointing to a real cpython clone) to see which version
of Sphinx we're using where::
Docs build server is configured to use Sphinx 2.3.1
Sphinx configuration in various branches:
======== ============= ============= ================== ==================== ============= ===============
branch travis azure requirements.txt conf.py Makefile Mac installer
======== ============= ============= ================== ==================== ============= ===============
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 sphinx==1.8.2 ø needs_sphinx='1.2' Sphinx==2.3.1
3.7 sphinx==1.8.2 sphinx==1.8.2 ø needs_sphinx="1.6.6" Sphinx==2.3.1 Sphinx==2.3.1
3.8 sphinx==1.8.2 sphinx==1.8.2 ø needs_sphinx='1.8' Sphinx==2.3.1 Sphinx==2.3.1
3.9 sphinx==2.2.0 sphinx==2.2.0 sphinx==2.2.0 needs_sphinx='1.8' Sphinx==2.3.1 Sphinx==2.3.1
master sphinx==2.2.0 sphinx==2.2.0 sphinx==2.2.0 needs_sphinx='1.8' Sphinx==2.3.1 Sphinx==2.3.1
======== ============= ============= ================== ==================== ============= ===============
Sphinx build as seen on docs.python.org:
======== ======= ===== ======= ===== ===== ===== ======= ===== =====
branch zh-tw fr pt-br es ja en zh-cn ko id
======== ======= ===== ======= ===== ===== ===== ======= ===== =====
2.7 2.3.1 2.3.1 2.3.1 ø 2.3.1 2.3.1 2.3.1 2.3.1 2.3.1
3.5 ø 1.6.2 ø ø 1.6.2 1.8.0 ø ø ø
3.6 2.3.1 2.3.1 2.3.1 2.3.1 2.3.1 2.3.1 2.3.1 2.3.1 2.3.1
3.7 2.3.1 2.3.1 2.3.1 2.3.1 2.3.1 2.3.1 2.3.1 2.3.1 2.3.1
3.8 2.3.1 2.3.1 2.3.1 2.3.1 2.3.1 2.3.1 2.3.1 2.3.1 2.3.1
3.9 2.3.1 2.3.1 2.3.1 2.3.1 2.3.1 2.3.1 2.3.1 2.3.1 2.3.1
3.10 2.3.1 2.3.1 2.3.1 2.3.1 2.3.1 2.3.1 2.3.1 2.3.1 2.3.1
======== ======= ===== ======= ===== ===== ===== ======= ===== =====