documenteer.conf

documenteer.conf Package

Functions

get_asset_path(name)	Get the absolute path for a static asset contained in Documenteer's assets directory, for use with Sphinx's html_static_path.
extend_static_paths_with_asset_extension(...)	Extend a Sphinx html_static_path configuration list with the files of a given extension in Documenteer's assets directory.
extend_excludes_for_non_index_source(...[, ...])	Extend the exclude_patterns configuration to include files with a specific extension that aren't the index file.
get_template_dir(root)	Get the absolute path for a Documenteer template directory, for use with Sphinx's templates_path.

Classes

DocumenteerConfig(conf)

Configuration from a documenteer.toml file.

Class Inheritance Diagram

documenteer.conf._toml Module

Parses a documenteer.toml configuration file to support documenteer’s configuration preset modules.

Classes

ConfigRoot	The root model for a documenteer.toml configuration file.
ProjectModel	Model for the project table in the documenteer.toml file.
PythonPackageModel	Model for a Python package (i.e. built with pyproject.toml-compatible build system.
OpenApiDocsModel	Model for OpenAPI documentation configurations in documenteer.toml.
OpenApiGeneratorModel	Specification for the OpenAPI generator function used by the documenteer.ext.openapi Sphinx extension.
SphinxModel	Model for Sphinx configurations in documenteer.toml.
IntersphinxModel	Model for Intersphinx configurations in documenteer.toml.
LinkCheckModel	Model for linkcheck builder configurations in documenteer.toml.
ThemeModel	Model for theme configurations in documenteer.toml.

Class Inheritance Diagram