documenteer.ext

documenteer.ext.autocppapi Module

Sphinx extension to generate a list of doxylink-based links to C++ APIs in a namespace.

Functions

setup(app)	Set up the documenteer.ext.autocppapi Sphinx extensions.
filter_symbolmap(symbol_map[, kinds, match])	Filter the entries in a symbol map to only those that match a certain API type or name regular expression.

Classes

AutoCppApi(name, arguments, options, ...)

The autocppapi directive that lists C++ APIs within a namespace, as detected by doxylink.

Class Inheritance Diagram

documenteer.ext.autodocreset Module

Sphinx extension to reset autodoc enhancements made by sphinx-automodapi that may be incompatible with LSST Science Pipelines API documentation.

Specifically, the automodapi autodoc enhancement that replaces the attr getter for type is incompatible with pybind11 static properties. This extension should be used after sphinx_automodapi.automodapi to reset the autodoc attr getter for type to the one built into autodoc.

Functions

setup(app)

Set up the documenteer.ext.autodocreset extension.

documenteer.ext.openapi Module

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

Functions

setup(app)	Entry point for the Sphinx extension.
generate_openapi_spec(app, config)	Generate the OpenAPI spec from a user-specified generator function.

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

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.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)	param app:

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

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

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