Skip to content

PDFs – using GitHub Actions to build them #181

@m-aciek

Description

@m-aciek

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 make logs public? docsbuild-scripts#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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions