Technotes

Rubin technical notes (or technotes) are often written in reStructuredText or Markdown. Documenteer provides centralized configuration and tooling for technotes.

Getting started

• Start a new technote
• Edit a technote on your own computer
• Editing a technote with the GitHub web UI
• How your technote gets published to the web
• Lint a technote
• Migrate legacy reStructuredText/Sphinx technical notes

Metadata

• Maintaining author metadata
• Describing the document status (draft, deprecated, or stable)

Content & design

• Citing references with BibTeX
  • Set up references section
  • Adding local BibTeX entries
  • Creating citations in text
  • Refresh bib files from lsst-texmf
• Accommodating wide content (tables, code blocks, and images)
  • Tables and code blocks
  • Images and figures

Sphinx configuration

• Configuring the Sphinx build
• Sphinx extensions in technotes

See also

To learn more about technotes:

• Rubin Observatory DM Developer Guide: Technotes for stand-alone technical documentation

• SQR-000: The LSST DM Technical Note Publishing Platform