Change CI such that Docs are no longer published to gh-pages
@shree-iyengar-dls đang làm issue này rồi.
Từ ngày 11/6/2026.
Đánh giá
Issue này chưa được đánh giá.
Mô tả
Currently, documentation for the source repo (main branch) is in the docs/ directory. The CI builds static docs based on the docs/ directory using sphinx. These docs get built into the build/html directory and packaged into a docs.zip. The docs.zip is not used for publishing but is instead stored as an artifact (for a job or release). It contains exactly one version of the docs. The docs in the build/html directory get moved to their respective folder in .github/pages which gets published to gh-pages. The GitHub pages site is built from the gh-pages branch and the switcher.json allows for switching between different versions (e.g. v1.0, v1.1). This is an issue, for example with the blueapi repo, as it leads to a large repo size which takes a long time to clone.
To address this issue, but still have access to documentation of previous versions, the suggested change is to create the entire site by consuming multiple docs.zip files (incl the one that has just been generated).
- Ngôn ngữ chính
- Jinja
- Star
- 25
- Fork
- 10
- Merge trung bình
- 4 ngày 17 giờ
- Pull request đã merge (30 ngày)
- 7
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- 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.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của DiamondLightSource/python-copier-template
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
-
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 68/100
-
documentation good first issue
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 70/100
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100