Change CI such that Docs are no longer published to gh-pages
@shree-iyengar-dls がすでに取り組んでいます。
2026年6月11日 から。
評価
この issue はまだ評価されていません。
説明
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).
- 主要言語
- Jinja
- スター
- 25
- フォーク
- 10
- 平均マージ
- 4日 17時間
- マージ済み PR(30日)
- 7
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
DiamondLightSource/python-copier-template のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
-
難易度 1/5 1時間未満 初心者へのやさしさ 68/100
-
documentation good first issue
難易度 1/5 1時間未満 初心者へのやさしさ 70/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100