Details
-
Type:
Story
-
Status: Done
-
Resolution: Done
-
Fix Version/s: None
-
Component/s: None
-
Labels:None
-
Story Points:3.8
-
Epic Link:
-
Team:SQuaRE
-
Urgent?:No
Description
Technotes are currently running on Documenteer 0.5, which pins Sphinx < 2. In DM-34228 we fixed an incompatibility of Documenteer 0.5 with Jinja2 >= 3.10. However, we also know that the technote builds are fundamentally compatible with Sphinx 4 and Documenteer 0.6+ in general, so it makes sense to take this opportunity to move the entire rst technote stack along:
- Update the template in https://github.com/lsst/templates to use documenteer 0.6+ and also adopt the newer configuration file format
- Announce the migration to the newer configuration file format in community.lsst.org.
- Begin running technote builds as part of the documenteer CI (i.e. integration testing)
Attachments
Issue Links
Activity
Released update to the technote_rst template in https://github.com/lsst/templates/pull/156
Released a new reusable workflows repository for Sphinx technotes at https://github.com/lsst-sqre/rubin-sphinx-technote-workflows. The GitHub Actions of individual Sphinx-based technotes can now reference the reusable workflow in that repo, thereby dramatically reducing the amount of duplicated CI code across all our technotes. The README of rubin-sphinx-technote-workflows provides an example of what a caller workflow might look like.
The initial PR is https://github.com/lsst-sqre/rubin-sphinx-technote-workflows/pull/1 (the branch got accidentally mislabeled with another ticket)