documenteer.conf¶
documenteer.conf Package¶
Functions¶
|
Get the absolute path for a static asset contained in Documenteer's assets directory, for use with Sphinx's |
Extend a Sphinx |
|
|
Extend the exclude_patterns configuration to include files with a specific extension that aren't the index file. |
|
Get the absolute path for a Documenteer template directory, for use with Sphinx's |
Classes¶
|
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¶
The root model for a documenteer.toml configuration file. |
|
Model for the project table in the documenteer.toml file. |
|
Model for a Python package (i.e. built with pyproject.toml-compatible build system. |
|
Model for OpenAPI documentation configurations in documenteer.toml. |
|
Specification for the OpenAPI generator function used by the |
|
Model for Sphinx configurations in documenteer.toml. |
|
Model for Intersphinx configurations in documenteer.toml. |
|
Model for linkcheck builder configurations in documenteer.toml. |
|
Model for theme configurations in documenteer.toml. |