python / python/docs-community

PDFs – using GitHub Actions to build them

Đang mở
#181 2 bình luận 1 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Ngôn ngữ chính
Makefile
Star
55
Fork
26
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

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.

Hướng dẫn đóng góp

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

Trước tiên, hãy xem xét repository docsbuild-scripts và issue 174, sau đó đánh giá cách các bản build tài liệu theo lịch có thể phát hành các artifact ngoại tuyến thông qua GitHub Pages. Đề xuất sẽ hoàn chỉnh khi build, bố cục artifact, khả năng hiển thị lỗi và các liên kết trên trang Downloads được xác định và thống nhất.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
github, github-actions
Lĩnh vực
build-system, ci-cd, documentation
Loại issue
Tính năng
Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Cần làm rõ
Mức phù hợp với người mới
25/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.