{"id":15008214,"url":"https://github.com/python/docsbuild-scripts","last_synced_at":"2025-04-05T07:05:31.801Z","repository":{"id":20280202,"uuid":"23553472","full_name":"python/docsbuild-scripts","owner":"python","description":"scripts for building documentation on docs.python.org","archived":false,"fork":false,"pushed_at":"2024-10-28T15:31:06.000Z","size":331,"stargazers_count":64,"open_issues_count":11,"forks_count":57,"subscribers_count":61,"default_branch":"main","last_synced_at":"2024-10-29T16:13:29.862Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/python.png","metadata":{"funding":{"custom":"https://www.python.org/psf/donations/python-dev/","github":["python"]},"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2014-09-01T19:29:17.000Z","updated_at":"2024-10-28T16:08:54.000Z","dependencies_parsed_at":"2023-02-12T18:50:26.995Z","dependency_job_id":"839656fe-cf14-405f-94e8-75b95aece8dc","html_url":"https://github.com/python/docsbuild-scripts","commit_stats":{"total_commits":338,"total_committers":30,"mean_commits":"11.266666666666667","dds":0.4023668639053254,"last_synced_commit":"bbf1112ac03e2045dfbcd76d04c99c5765fd35db"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/python%2Fdocsbuild-scripts","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/python%2Fdocsbuild-scripts/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/python%2Fdocsbuild-scripts/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/python%2Fdocsbuild-scripts/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/python","download_url":"https://codeload.github.com/python/docsbuild-scripts/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246952409,"owners_count":20859833,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-09-24T19:15:36.869Z","updated_at":"2025-04-05T07:05:31.784Z","avatar_url":"https://github.com/python.png","language":"Python","funding_links":["https://www.python.org/psf/donations/python-dev/","https://github.com/sponsors/python"],"categories":[],"sub_categories":[],"readme":"This repository contains scripts for automatically building the Python\ndocumentation on [docs.python.org](https://docs.python.org).\n\n\n## How to test it?\n\nThe following command should build all maintained versions and\ntranslations in `./www`, beware it can take a few hours:\n\n```shell\npython3 ./build_docs.py --quick --build-root ./build_root --www-root ./www --log-directory ./logs --group $(id -g) --skip-cache-invalidation\n```\n\nIf you don't need to build all translations of all branches, add\n`--language en --branch main`.\n\n\n## Check current version\n\nInstall `tools_requirements.txt` then run `python check_versions.py\n../cpython/` (pointing to a real CPython clone) to see which version\nof Sphinx we're using where:\n\n    Sphinx configuration in various branches:\n\n    =========  =============  ==================  ====================\n    version    travis         requirements.txt    conf.py\n    =========  =============  ==================  ====================\n    2.7        sphinx~=2.0.1  ø                   needs_sphinx='1.2'\n    3.5        sphinx==1.8.2  ø                   needs_sphinx='1.8'\n    3.6        sphinx==1.8.2  ø                   needs_sphinx='1.2'\n    3.7        sphinx==1.8.2  sphinx==2.3.1       needs_sphinx=\"1.6.6\"\n    3.8        ø              sphinx==2.4.4       needs_sphinx='1.8'\n    3.9        ø              sphinx==2.4.4       needs_sphinx='1.8'\n    3.10       ø              sphinx==3.4.3       needs_sphinx='3.2'\n    3.11       ø              sphinx~=7.2.0       needs_sphinx='4.2'\n    3.12       ø              sphinx~=8.1.0       needs_sphinx='7.2.6'\n    3.13       ø              sphinx~=8.1.0       needs_sphinx='7.2.6'\n    3.14       ø              sphinx~=8.1.0       needs_sphinx='7.2.6'\n    =========  =============  ==================  ====================\n\n    Sphinx build as seen on docs.python.org:\n\n    =========  =====  =====  =====  =====  =====  =====  =====  =====  =======  =====  =====  =======  =======\n    version    en     es     fr     id     it     ja     ko     pl     pt-br    tr     uk     zh-cn    zh-tw\n    =========  =====  =====  =====  =====  =====  =====  =====  =====  =======  =====  =====  =======  =======\n    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  2.4.4  2.4.4    2.4.4\n    3.10       3.4.3  3.4.3  3.4.3  3.4.3  3.4.3  3.4.3  3.4.3  3.4.3  3.4.3    3.4.3  3.4.3  3.4.3    3.4.3\n    3.11       7.2.6  7.2.6  7.2.6  7.2.6  7.2.6  7.2.6  7.2.6  7.2.6  7.2.6    7.2.6  7.2.6  7.2.6    7.2.6\n    3.12       8.1.3  8.1.3  8.1.3  8.1.3  8.1.3  8.1.3  8.1.3  8.1.3  8.1.3    8.1.3  8.1.3  8.1.3    8.1.3\n    3.13       8.1.3  8.1.3  8.1.3  8.1.3  8.1.3  8.1.3  8.1.3  8.1.3  8.1.3    8.1.3  8.1.3  8.1.3    8.1.3\n    3.14       8.1.3  8.1.3  8.1.3  8.1.3  8.1.3  8.1.3  8.1.3  8.1.3  8.1.3    8.1.3  8.1.3  8.1.3    8.1.3\n    =========  =====  =====  =====  =====  =====  =====  =====  =====  =======  =====  =====  =======  =======\n\n## Manually rebuild a branch\n\nDocs for [feature and bugfix branches](https://devguide.python.org/versions/) are\nautomatically built from a cron.\n\nManual rebuilds are needed for new security releases,\nand to add the end-of-life banner for newly end-of-life branches.\n\nTo manually rebuild a branch, for example 3.11:\n\n```shell\nssh docs.nyc1.psf.io\nsudo su --shell=/bin/bash docsbuild\nscreen -DUR  # Rejoin screen session if it exists, otherwise create a new one\n/srv/docsbuild/venv/bin/python /srv/docsbuild/scripts/build_docs.py --branch 3.11\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpython%2Fdocsbuild-scripts","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpython%2Fdocsbuild-scripts","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpython%2Fdocsbuild-scripts/lists"}