documenteer.ext

documenteer.ext.openapi Module

A Sphinx extension for generating the OpenAPI Spec for a FastAPI application.

Functions

generate_openapi_spec(app, config)	Generate the OpenAPI spec from a user-specified generator function.
setup(app)	Set up the OpenAPI extension.

documenteer.ext.bibtex Module

Support for Rubin BibTeX files for pybtex/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.ext.jira Module

Rubin JIRA ticket reference roles.

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

Functions

getLogger(name)	Get logger wrapped by sphinx.util.logging.SphinxLoggerAdapter.
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)	Set up the Jira ticket reference roles.

documenteer.ext.lsstdocushare Module

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)	Set up the LSST DocuShare and ls.st reference roles.

documenteer.ext.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

getLogger(name)	Get logger wrapped by sphinx.util.logging.SphinxLoggerAdapter.
mock_code_ref_role(name, rawtext, text, ...)	Process a mock code reference role.
setup(app)	Set up the mock code reference roles.