Change CI such that Docs are no longer published to gh-pages
Bewertung
Dieses Issue wurde noch nicht bewertet.
Beschreibung
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).
- Vorherrschende Sprache
- Jinja
- Sterne
- 25
- Forks
- 9
- Ø Merge
- 4 Std. 36 Min.
- Gemergte PRs (30 T.)
- 4
Entwicklungsumgebung
Startet den Dev-Container des Projekts im Browser, mit Ihrem eigenen GitHub-Konto.
- Enthält ein Dockerfile oder eine Docker-Compose-Datei
- Keine Pull-Request-Vorlage
- Beitragsleitfaden lesen
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus DiamondLightSource/python-copier-template
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
-
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 68/100
-
documentation good first issue
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 70/100
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100