From fdb661e900f3a0c4ffa10150fb5adc0a85691fba Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade Date: Sat, 15 May 2021 20:11:18 +0300 Subject: [PATCH 1/4] Sort languages so README table is consistent and diffs smaller --- check_versions.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) 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", ) ) From 3ca9164e9520c1f82c62810b9cf6e9b4be2a9a03 Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade Date: Sat, 15 May 2021 20:11:52 +0300 Subject: [PATCH 2/4] Fix typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c1ec571..226d9e3 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ If you don't need to build all translations of all branches, add # Check current version -Install `tools-requirements.txt` then run ``python check_versions.py +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:: From 3620a7d279842d84b91513903f42a8f8263b859d Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade Date: Sat, 15 May 2021 20:16:02 +0300 Subject: [PATCH 3/4] Bump versions table in README --- README.md | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 226d9e3..e4a0376 100644 --- a/README.md +++ b/README.md @@ -30,23 +30,23 @@ 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 + ======== ===== ===== ===== ===== ===== ===== ===== ======= ======= ======= From e0416accea8e0fb5d6d32115cdd70f9c54124b24 Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade Date: Sat, 15 May 2021 20:18:24 +0300 Subject: [PATCH 4/4] Update for Markdown --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index e4a0376..f10be71 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