documenteer.conf

documenteer.conf Package

Functions

extend_excludes_for_non_index_source(...[, ...])	Extend the exclude_patterns configuration to include files with a specific extension that aren't the index file.
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.
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.
get_template_dir(root)	Get the absolute path for a Documenteer template directory, for use with Sphinx's templates_path.
raising_config_errors()	Make a configuration failure inside the block raise ConfigError instead of ending the process.

Classes

DocumenteerConfig(conf[, root_dir])

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

CitationAuthorModel(*[, name, ror, ...])	Model for an author of a [[project.citations]] entry.
CitationDefaultsModel(*[, type, publisher, ...])	Model for the [project.citation_defaults] table of documenteer.toml.
CitationModel(*[, doi, url, label, type, ...])	Model for an entry in the [[project.citations]] array of documenteer.toml.
ConfigRoot(*, project[, sphinx])	The root model for a documenteer.toml configuration file.
IntersphinxCacheModel(*[, use_service, ...])	Model for the Ook intersphinx inventory cache configuration in documenteer.toml.
IntersphinxModel(*[, projects, cache])	Model for Intersphinx configurations in documenteer.toml.
LinkCheckModel(*[, ignore, use_service, ...])	Model for linkcheck builder configurations in documenteer.toml.
OpenApiDocsModel(*[, generator, ...])	Model for OpenAPI documentation configurations in documenteer.toml.
OpenApiGeneratorModel(*, function[, ...])	Specification for the OpenAPI generator function used by the documenteer.ext.openapi Sphinx extension.
ProjectModel(*, title[, base_url, ...])	Model for the project table in the documenteer.toml file.
PythonPackageModel(*, package[, ...])	Model for a Python package (i.e. built with pyproject.toml-compatible build system.
SphinxModel(*[, rst_epilog_file, ...])	Model for Sphinx configurations in documenteer.toml.
ThemeModel(*[, show_github_edit_link, ...])	Model for theme configurations in documenteer.toml.

Class Inheritance Diagram