python / python/docs-community
PDFs – using GitHub Actions to build them
还没有人认领这个 Issue。
- 主要语言
- 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.
贡献指南
这个仓库没有索引到贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
首先审查 docsbuild-scripts 仓库和 issue 174,然后评估如何通过 GitHub Pages 发布定期文档构建的离线制品。确定并达成对构建、制品布局、失败可见性以及 Downloads 页面链接的共识后,该提案才算完成。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- github, github-actions
- 领域
- build-system, ci-cd, documentation
- Issue 类型
- 功能
- 难度
- 5/5
- 预计耗时
- 一周以上
- 活跃度
- 停滞
- 描述清晰度
- 需要澄清
- 新手友好度
- 25/100