python / python/docs-community

PDFs – using GitHub Actions to build them

Ouverte
#181 2 commentaires 1 réaction 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
Makefile
Étoiles
55
Forks
26
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

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.

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Examinez d’abord le dépôt docsbuild-scripts et l’issue 174, puis évaluez comment des builds de documentation planifiés pourraient publier des artefacts hors ligne via GitHub Pages. La proposition serait complète lorsque le build, la disposition des artefacts, la visibilité des échecs et les liens de la page Downloads seraient définis et approuvés.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
github, github-actions
Domaine
build-system, ci-cd, documentation
Type d'issue
Fonctionnalité
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
À clarifier
Accessibilité débutants
25/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.