documenteer.sphinxext#

documenteer.sphinxext Package#

Sphinx/docutils extensions for LSST DM documentation.

Enable these extension by adding documenteer.sphinxext to your extensions list in conf.py:

extensions = [
   # ...
   'documenteer.sphinxext'
]

Some extensions require project-specific dependencies and are not automatically enabled. They should be specified individually. They are:

  • documenteer.sphinxext.bibtex

Functions#

setup(app)

Wrapper for the setup functions of each extension module.

documenteer.sphinxext.bibtex Module#

Extensions to support LSST bibliographies with sphinxcontrib-bibtex.

Functions#

setup(app)

Add this plugin to the Sphinx application.

Classes#

LsstBibtexStyle([label_style, name_style, ...])

Bibtex style that understands docushare fields in LSST bibliographies.

documenteer.sphinxext.jira Module#

JIRA ticket reference roles (for stories, epics, RFCs, etc.).

This module is heavily influenced by sphinx-issue (Steven Loria). See /licenses/sphinx-issue.txt for licensing information.

Functions#

jira_bracket_role(name, rawtext, text, ...)

Sphinx role for referencing a JIRA ticket with ticket numbers enclosed in braces.

jira_parens_role(name, rawtext, text, ...[, ...])

Sphinx role for referencing a JIRA ticket with ticket numbers enclosed in parentheses.

jira_role(name, rawtext, text, lineno, inliner)

Sphinx role for referencing a JIRA ticket.

setup(app)

documenteer.sphinxext.lsstdocushare Module#

LSST LSST the Docs and DocuShare/ls.st reference roles.

Functions#

lsst_doc_shortlink_role(name, rawtext, text, ...)

Link to LSST documents given their handle using LSST's ls.st link shortener.

lsst_doc_shortlink_titlecase_display_role(...)

Link to LSST documents given their handle using LSST's ls.st link shortener with the document handle displayed in title case.

lsstio_doc_shortlink_role(name, rawtext, ...)

Link to LSST documents given their handle that are hosted on lsst.io (Rubin's deployment of LSST the Docs).

setup(app)

param app:

documenteer.sphinxext.mockcoderefs Module#

Sphinx extensions to mock Python code reference roles.

These roles are useful for temporarily adding semantically-markedup APIs while waiting for the API reference itself to be added.

Functions#

mock_code_ref_role(name, rawtext, text, ...)

setup(app)

documenteer.sphinxext.packagetoctree Module#

Sphinx extensions for creating toctrees for packages and modules for the Pipelines documentation.

Functions#

setup(app)

Classes#

ModuleTocTree(name, arguments, options, ...)

Toctree that automatically displays a list of modules in the Stack documentation.

PackageTocTree(name, arguments, options, ...)

Toctree that automatically lists packages in the Stack documentation.