Details
-
Type:
Story
-
Status: Done
-
Resolution: Done
-
Fix Version/s: None
-
Component/s: None
-
Labels:None
-
Story Points:3
-
Epic Link:
-
Team:SQuaRE
-
Urgent?:No
Description
We've created a new theme for Rubin user guides in Documenteer. While implementing the theme in Documenteer and Safir, we've come across some patterns, best practices and potential pitfalls. The purpose of this ticket is to write user guides for these known topics:
- Structuring the toctrees of sites
- How to hide the primary and secondary sidebars
- How to use sphinx design elements like tab sets, captions for code blocks, etc.
- Using the rst epilog
- Configuring a Python API reference
- Markdown support
These docs come in from https://github.com/lsst-sqre/documenteer/pull/136 and you can find them at https://documenteer.lsst.io/project-guides/guides/index.html