Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

scripts for building documentation on docs.python.org

NotificationsYou must be signed in to change notification settings

python/docsbuild-scripts

Repository files navigation

GitHub Actions statusCodecov

This repository contains scripts for automatically building the Pythondocumentation ondocs.python.org.

How to test it?

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-invalidation

If you don't need to build all translations of all branches, add--languages en --branches main.

Sphinx versions

Sphinx configuration in various branches:

versionrequirements.txtconf.py
2.6øø
2.7øø
3.0øø
3.1øø
3.2øø
3.3øø
3.4øneeds_sphinx='1.2'
3.5øø
3.6øø
3.7øø
3.8øø
3.9sphinx==2.4.4needs_sphinx='1.8'
3.10sphinx==3.4.3needs_sphinx='3.2'
3.11sphinx~=7.2.0needs_sphinx='4.2'
3.12sphinx~=8.2.0needs_sphinx='8.2.0'
3.13sphinx~=8.2.0needs_sphinx='8.2.0'
3.14sphinx~=8.2.0needs_sphinx='8.2.0'
3.15sphinx~=8.2.0needs_sphinx='8.2.0'

Sphinx build as seen on docs.python.org:

versionelenesfrbn-iniditjakoplpt-brrotrukzh-cnzh-tw
2.6ø0.6.5øøøøøøøøøøøøøø
2.7ø2.3.1ø2.3.1ø2.3.1ø2.3.12.3.1ø2.3.1øøø2.3.12.3.1
3.0ø0.6øøøøøøøøøøøøøø
3.1ø0.6.5øøøøøøøøøøøøøø
3.2ø1.0.7øøøøøøøøøøøøøø
3.3ø1.2øøøøøøøøøøøøøø
3.4ø1.2.3øøøøøøøøøøøøøø
3.5ø1.8.41.8.41.8.4ø1.8.4ø1.8.41.8.41.8.41.8.4øøø1.8.41.8.4
3.6ø2.3.12.3.12.3.1ø2.3.1ø2.3.12.3.12.3.12.3.1øøø2.3.12.3.1
3.7ø2.3.12.3.12.3.1ø2.3.12.3.12.3.12.3.12.3.12.3.1ø2.3.12.3.12.3.12.3.1
3.8ø2.4.42.4.42.4.4ø2.4.42.4.42.4.42.4.42.4.42.4.4ø2.4.42.4.42.4.42.4.4
3.92.4.42.4.42.4.42.4.42.4.42.4.42.4.42.4.42.4.42.4.42.4.42.4.42.4.42.4.42.4.42.4.4
3.103.4.33.4.33.4.33.4.33.4.33.4.33.4.33.4.33.4.33.4.33.4.33.4.33.4.33.4.33.4.33.4.3
3.117.2.67.2.67.2.67.2.67.2.67.2.67.2.67.2.67.2.67.2.67.2.67.2.67.2.67.2.67.2.67.2.6
3.128.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.3
3.138.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.3
3.148.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.3
3.158.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.38.2.3

Installtools_requirements.txt then runpython check_versions.py ../cpython/ (pointing to a real CPython clone) to see which versionsof Sphinx we're using.

Or runtox -e cog (with a clone at../cpython) to directly update these tables.

Manually rebuild a branch

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 --branches 3.11

About

scripts for building documentation on docs.python.org

Resources

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors32

[8]ページ先頭
©2009-2025 Movatter.jp