DiamondLightSource / DiamondLightSource/python-copier-template

Change CI such that Docs are no longer published to gh-pages

オープン
#344 コメント 1 件 リアクション 0 件 担当者 1 名 @shree-iyengar-dls が担当を希望しています GitHub で見る
主要言語
Jinja
スター
25
フォーク
10
平均マージ
4時間 4分
マージ済み PR(30日)
6

説明

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).

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

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

評価

この issue はまだ評価されていません。

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

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