python / python/docs-community

PDFs – using GitHub Actions to build them

Abierto
#181 2 comentarios 1 reacción 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Lenguaje dominante
Makefile
Estrellas
55
Forks
26
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

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.

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Revisa primero el repositorio docsbuild-scripts y el issue 174; después, evalúa cómo las compilaciones programadas de documentación podrían publicar artefactos sin conexión mediante GitHub Pages. La propuesta estaría completa cuando se hayan definido y acordado la compilación, la disposición de los artefactos, la visibilidad de los fallos y los enlaces de la página Downloads.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
github, github-actions
Área
build-system, ci-cd, documentation
Tipo de issue
Nueva funcionalidad
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Necesita aclaración
Aptitud para principiantes
25/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.