python / python/docs-community

PDFs – using GitHub Actions to build them

オープン
#181 コメント 2 件 リアクション 1 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

主要言語
Makefile
スター
55
フォーク
26
PR マージ指標
30日以内にマージされた PR はありません

説明

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.

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

まず docsbuild-scripts リポジトリと issue 174 を確認し、その後、スケジュールされたドキュメントビルドで GitHub Pages を通じてオフラインアーティファクトを公開する方法を評価します。ビルド、アーティファクトの配置、失敗の可視性、Downloads ページへのリンクが定義され、合意されれば、提案は完成です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
github, github-actions
領域
build-system, ci-cd, documentation
issue の種類
機能追加
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
25/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。