docs.conf

Configure Sphinx.

Module Contents

Data

__metadata__	Configure Sphinx from dynamically loaded project metadata.
author	Credits for this version.
autodoc2_packages	Search these locations for code to document.
autodoc2_render_plugin	Render docstrings using MyST Markdown.
autodoc2_sort_names	When documenting the API, sort by name.
bibtex_bibfiles	BibTeX citations.
copyright	The years over which the work was done.
exclude_patterns	Ignore these files/folders when sourcing content.
extensions	This documentation uses several Sphinx extensions.
html_context
html_favicon
html_sidebars
html_static_path
html_theme	Use the Sphinx Book Theme template for web content.
html_theme_options	Configure web content generation.
html_theme_path
html_title	The title for HTML documentation; cf. html_title.
intersphinx_mapping	Cross-reference other Sphinx documentation projects.
locale_dirs
myst_dmath_double_inline
myst_enable_checkboxes
myst_enable_extensions	Enable all MyST parser extensions.
myst_footnote_transition
myst_heading_anchors
myst_url_schemes	Define custom URL schemes; cf. Cross-references.
nitpicky
project	The project name.
release	The full version number, including the patch level (X.Y.Z).
suppress_warnings
templates_path	These directories contain documentation templates.
version	The short version number (X.Y).
viewcode_line_numbers	Add line numbers to embedded source code listings.

API

docs.conf.__metadata__

‘load(…)’

Configure Sphinx from dynamically loaded project metadata.

docs.conf.author

‘Research Data and Communication Technologies Benefit Corp.’

Credits for this version.

docs.conf.autodoc2_packages

None

Search these locations for code to document.

docs.conf.autodoc2_render_plugin

‘myst’

Render docstrings using MyST Markdown.

docs.conf.autodoc2_sort_names

True

When documenting the API, sort by name.

docs.conf.bibtex_bibfiles

[‘refs.bib’]

BibTeX citations.

docs.conf.copyright

‘2026’

The years over which the work was done.

docs.conf.exclude_patterns

[‘.*’, ‘Thumbs.db’, ‘.DS_Store’]

Ignore these files/folders when sourcing content.

docs.conf.extensions

[‘autodoc2’, ‘myst_parser’, ‘sphinx.ext.githubpages’, ‘sphinx.ext.intersphinx’, ‘sphinx.ext.viewcode…

This documentation uses several Sphinx extensions.

sphinx-autodoc2

Generate API documentation automatically.

myst-parser

Render Markdown in documentation and docstrings.

sphinx.ext.githubpages

Publish HTML documentation in GitHub Pages.

sphinx.ext.intersphinx

Link to other projects’ documentation.

sphinx.ext.viewcode

Link to highlighted source code.

sphinx-copybutton

Add a copy button to code blocks.

sphinx-design

Provide screen-size responsive web components.

Sphinx PyScript

Use PyScript in built documentation.

Sphinx Tippy

Add rich hints (tooltips) to built documentation.

sphinx-togglebutton

Add collapsable admonitions (notes, warnings, etc.) to built documentation.

<inv:sphbibtex:std:doc#index sphinxcontrib-bibtex>

Allow BibTeX citations to be inserted into documentation generated by Sphinx via a bibliography directive, along with cite:p and cite:t roles.

sphinxcontrib.cairosvgconverter

Convert SVG diagrams to PDF for output formats that do not support SVG natively.

sphinxext-opengraph

Turn web pages into Open Graph objects.

sphinxext-rediraffe

Fix broken internal links due to deleted/renamed pages.

docs.conf.html_context

None

docs.conf.html_favicon

‘_static/favicon-32x32.png’

docs.conf.html_sidebars

None

docs.conf.html_static_path

[‘_static’]

docs.conf.html_theme

‘sphinx_book_theme’

Use the Sphinx Book Theme template for web content.

docs.conf.html_theme_options

None

Configure web content generation.

home_page_in_toc

Add the home page to the table of contents.

repository_url, path_to_docs, use_edit_page_button, use_repository_button, use_issues_button

Link to doc sources and include buttons for suggesting edits or creating new issues.

use_fullscreen_button

Add a button to show the site full screen.

docs.conf.html_theme_path

None

docs.conf.html_title

None

The title for HTML documentation; cf. html_title.

docs.conf.intersphinx_mapping

None

Cross-reference other Sphinx documentation projects.

Use the sphobjinv suggest command to find intersphinx references using the documentation URL, e.g., sphobjinv suggest -u https://sphobjinv.readthedocs.io/en/latest/cli/suggest.html suggest.

docs.conf.locale_dirs

[‘_locales’]

docs.conf.myst_dmath_double_inline

True

docs.conf.myst_enable_checkboxes

True

docs.conf.myst_enable_extensions

[‘amsmath’, ‘attrs_block’, ‘attrs_inline’, ‘colon_fence’, ‘deflist’, ‘dollarmath’, ‘fieldlist’, ‘htm…

Enable all MyST parser extensions.

For more information, refer to the documentation.

docs.conf.myst_footnote_transition

True

docs.conf.myst_heading_anchors

2

docs.conf.myst_url_schemes

None

Define custom URL schemes; cf. Cross-references.

Note

Preview builds of the documentation, e.g., created by the make html command, will not have valid links to source code on GitHub. The github: scheme only correctly accounts for the project’s current version when performing a multi-version build of the documentation via the make docs command.

docs.conf.nitpicky

True

docs.conf.project

None

The project name.

docs.conf.release

None

The full version number, including the patch level (X.Y.Z).

docs.conf.suppress_warnings

[‘myst.strikethrough’]

docs.conf.templates_path

[‘_templates’]

These directories contain documentation templates.

Paths are relative to this file’s parent directory.

docs.conf.version

‘join(…)’

The short version number (X.Y).

docs.conf.viewcode_line_numbers

True

Add line numbers to embedded source code listings.