- Notifications
You must be signed in to change notification settings - Fork0
Python-Repository-Hub/docsbuild-scripts
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
This repository contains scripts for automatically building the Pythondocumentation ondocs.python.org.
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-invalidationIf you don't need to build all translations of all branches, add--language en --branch main.
Installtools_requirements.txt then runpython check_versions.py ../cpython/ (pointing to a real CPython clone) to see which versionof Sphinx we're using where:
Sphinx configuration in various branches:======== ============= ============= ================== ==================== ============= ===============version 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==2.4.4 needs_sphinx='1.8' ø ø 3.9 ø ø sphinx==2.4.4 needs_sphinx='1.8' ø ø 3.1 ø ø sphinx==3.2.1 needs_sphinx='1.8' ø ø 3.11 ø ø sphinx==4.5.0 needs_sphinx='1.8' ø ø======== ============= ============= ================== ==================== ============= ===============Sphinx build as seen on docs.python.org:======== ===== ===== ===== ===== ===== ===== ===== ======= ======= =======version 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 2.3.1 2.3.13.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.43.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.13.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.13.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.43.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.43.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.13.11 4.2.0 4.2.0 4.2.0 4.2.0 4.2.0 4.2.0 4.2.0 4.2.0 4.2.0 4.2.0======== ===== ===== ===== ===== ===== ===== ===== ======= ======= =======build_docs_server.py is a simple HTTP server handling Github Webhooksrequests to build the doc when needed. It only needspush events.
Its logging can be configured by giving a yaml file path to the--logging-config argument.
By default the loglevel isDEBUG onstderr, the default config canbe found in the code so one can bootstrap a different config from it.
About
scripts for building documentation on docs.python.org
Resources
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Releases
Packages0
Languages
- Python84.3%
- JavaScript12.9%
- HTML2.8%