documenteer.ext#

documenteer.ext.openapi Module#

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

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

Support for Rubin BibTeX files for pybtex/sphinxcontrib.bibtex.

Add this plugin to the Sphinx application.

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

Bibtex style that understands docushare fields in LSST bibliographies.

Rubin JIRA ticket reference roles.

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

`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.

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

`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.

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.

`mock_code_ref_role`(name, rawtext, text, ...)	Process a mock code reference role.
`setup`(app)	Set up the mock code reference roles.