python / python/docs-community
PDFs – using GitHub Actions to build them
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Makefile
- Sterne
- 55
- Forks
- 26
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
In September 2025 we've removed PDF downloads of Python documentation.
Two main reasons were maintenance burden and compute resources. I would like to propose a solution addressing the second of those issues.
Building the offline documentation with GitHub Actions and publishing it with GitHub Pages.
I started to work on proof of concept in a separate repository, but came to conclusion that the docsbuild-scripts repository is possibly a better candidate for this purpose. It would allow to reuse code connected with building docs and keeping related processes together.
My vision is following: docs builds scheduled repeatedly on GitHub Actions and pushed as artifacts to GitHub pages site, with directories layout of docs.python.org offline artifacts. We could then link from Downloads page of online docs to the files from the new automation, either at python.github.io/docsbuild-scripts or at a custom domain under python.org set to serve the site.
Regarding the maintenance burden with PDF docs:
- I think one of biggest culprits was that logs from failed builds were previously available only to very limited group of people, having build jobs logs exposed publicly in GitHub Actions it will be easier for community to act upon the failures from the bottom up (see https://github.com/python/docsbuild-scripts/issues/174)
- I think we can investigate alternative PDF builders simultanously (see
- and try to engage more the language teams to help solve issues with their languages' PDF builds.
What does the community think? If there are no objections, I'd be happy to start working on a PR for docsbuild-scripts.
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Prüfe zuerst das docsbuild-scripts-Repository und Issue 174 und beurteile anschließend, wie geplante Dokumentations-Builds Offline-Artefakte über GitHub Pages veröffentlichen könnten. Der Vorschlag wäre vollständig, wenn der Build, das Artefaktlayout, die Sichtbarkeit von Fehlern und die Links auf der Downloads-Seite definiert und abgestimmt sind.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- github, github-actions
- Bereich
- build-system, ci-cd, documentation
- Issue-Typ
- Feature
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 25/100