Details
-
Type:
Story
-
Status: Done
-
Resolution: Done
-
Fix Version/s: None
-
Component/s: None
-
Labels:None
-
Story Points:13.6
-
Epic Link:
-
Team:SQuaRE
-
Urgent?:No
Description
With DM-36955 and DM-36883 we demonstrated how to merge the bibliographic metadata that's either declared in technote.toml or introspected from the document (title and abstract) and make this information available to the HTML builder's Jinja context.
The next step is to now begin developing and styling the HTML page using this information. At the same time, we are aware that technote is intended as a base framework that upstream packages, like documenteer, can further customize/theme. Thus the HTML design must be designed to be easily extensible.
The purpose of this ticket is to begin developing the HTML/CSS design of technote to produce a "minimum viable" product that we can begin to use internally for SQuaRE technote. Ideally we'll also begin integrating technote into documenteer to prove out the theming storying and begin developing a Rubin-specific theme.
Attachments
Activity
Also attached a screenshot of the Rubin customization of the technote theme, which includes our imagotype as well as accent colouring to match our brand.
Released technote 0.2.0 with the new base theme and Sphinx extensions: https://github.com/lsst-sqre/technote/releases/tag/0.2.0
For documenteer, I'm going to keep the PR (https://github.com/lsst-sqre/documenteer/pull/144) open to allow for more work to be done before merging the new technotes to main and therefore the Rubin community. Probably for a documenteer 0.8 release. It's possible that the new technotes may drop support for Sphinx < 5 and Python < 3.8, so we'll need to test that to ensure there's a supported path forward for legacy technotes and other Documenteer users.
We've merged that branch and will managed very old technote instances that need to be updated to Python 3.10 or 3.11.
Attached screenshots of the default technote theme in desktop and mobile contexts.