Skip to main content
Ctrl+K

Documenteer

  • Rubin user guides
  • Technical notes
  • Sphinx extensions
  • Change Log
  • Development
    • Rubin docs
  • GitHub
  • Rubin user guides
  • Technical notes
  • Sphinx extensions
  • Change Log
  • Development
  • Rubin docs
  • GitHub

Section Navigation

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
  • Migrate legacy reStructuredText/Sphinx technical notes

Metadata

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

Content & design

  • Accommodating wide content (tables, code blocks, and images)

Sphinx configuration

  • Configuring the Sphinx build
  • Sphinx extensions in technotes
  • Technotes

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
  • Migrate legacy reStructuredText/Sphinx technical notes

Metadata

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

Content & design

  • 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

previous

The documenteer.conf.guide configuration preset

next

Start a new technote

Edit on GitHub

© Copyright 2015-2022 Association of Universities for Research in Astronomy, Inc. (AURA).

Created using Sphinx 8.1.3.

Built with the PyData Sphinx Theme 0.16.1.