Skip to content

Bump versions table in README #111

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
May 21, 2021
Merged

Bump versions table in README #111

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
fdb661e
Sort languages so README table is consistent and diffs smaller
hugovk May 15, 2021
3ca9164
Fix typo
hugovk May 15, 2021
3620a7d
Bump versions table in README
hugovk May 15, 2021
e0416ac
Update for Markdown
hugovk May 15, 2021
4ebdd12
Merge branch 'main' into update-versions
JulienPalard May 21, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 24 additions & 22 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
Expand Down
5 changes: 4 additions & 1 deletion check_versions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
)
)
Expand Down