documenteer.ext#

documenteer.ext.bibtex Module#

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

Functions#

setup(app)

Add this plugin to the Sphinx application.

documenteer.ext.githubbibcache Module#

A Sphinx extension that caches BibTeX files from GitHub repositories.

These bibfiles can be used with sphinxcontrib-bibtex’s bibliography directive.

Functions#

setup(app)

Set up the documenteer.ext.autocppapi Sphinx extensions.

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#

setup(app)

Set up the Jira ticket reference roles.

documenteer.ext.lsstdocushare Module#

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

Functions#

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#

setup(app)

Set up the mock code reference roles.

documenteer.ext.openapi Module#

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

Functions#

setup(app)

Set up the OpenAPI extension.

documenteer.ext.remotecodeblock Module#

remote-code-block directive that works like literalinclude, but supports getting content over https.

Functions#

setup(app)

Set up the remote-code-block directive.

documenteer.ext.robots Module#

Sphinx extension for automatically generating robots.txt files.

This extension automatically creates and inserts a robots.txt file into the built HTML site if no such robots.txt file already exists and if a sitemap.xml file does exist in the built site. In the generated robots.txt file, it links to the sitemap using the Sphinx html_baseurl configuration value.

Functions#

`generate_robots_txt`(app, exception)	Generate a robots.txt file automatically if conditions are met.
`setup`(app)	Set up the robots extension.