diff --git a/README.md b/README.md index a11b4a3..daf54f7 100644 --- a/README.md +++ b/README.md @@ -5,19 +5,21 @@ documentation on [docs.python.org](https://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: +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 +```shell +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 main``. +`--language en --branch main`. # 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:: +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 @@ -30,26 +32,26 @@ of Sphinx we're using where:: 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 - 3.10 sphinx==2.2.0 sphinx==2.2.0 sphinx==2.2.0 needs_sphinx='1.8' Sphinx==2.3.1 Sphinx==2.3.1 - main sphinx==2.2.0 sphinx==2.2.0 sphinx==2.2.0 needs_sphinx='1.8' Sphinx==2.3.1 Sphinx==2.3.1 + 3.8 sphinx==1.8.2 sphinx==2.4.4 needs_sphinx='1.8' + 3.9 sphinx==2.2.0 sphinx==2.4.4 needs_sphinx='1.8' + 3.10 sphinx==3.2.1 needs_sphinx='1.8' + main sphinx==3.2.1 needs_sphinx='1.8' ======== ============= ============= ================== ==================== ============= =============== 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 - 3.11 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 - ======== ======= ===== ======= ===== ===== ===== ======= ===== ===== + ======== ===== ===== ===== ===== ===== ===== ===== ======= ======= ======= + branch en es fr id ja ko pl pt-br zh-cn zh-tw + ======== ===== ===== ===== ===== ===== ===== ===== ======= ======= ======= + 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.8.4 1.8.4 1.8.4 1.8.4 1.8.4 1.8.4 1.8.4 1.8.4 1.8.4 1.8.4 + 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 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 2.3.1 + 3.8 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 + 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 + 3.10 3.2.1 3.2.1 3.2.1 3.2.1 3.2.1 3.2.1 3.2.1 3.2.1 3.2.1 3.2.1 + 3.11 3.2.1 3.2.1 3.2.1 3.2.1 3.2.1 3.2.1 3.2.1 3.2.1 3.2.1 3.2.1 + ======== ===== ===== ===== ===== ===== ===== ===== ======= ======= ======= ## The github hook server diff --git a/check_versions.py b/check_versions.py index 6a8bf9a..f7ea1ce 100644 --- a/check_versions.py +++ b/check_versions.py @@ -107,7 +107,10 @@ async def which_sphinx_is_used_in_production(): tabulate( table, disable_numparse=True, - headers=["branch", *[language.tag for language in build_docs.LANGUAGES]], + headers=[ + "branch", + *[language.tag for language in sorted(build_docs.LANGUAGES)], + ], tablefmt="rst", ) )