DocumenteerConfig#

class documenteer.conf.DocumenteerConfig(conf)#

Bases: object

Configuration from a documenteer.toml file.

Parameters:

conf (ConfigRoot) –

Attributes Summary

base_url

Base root URL for the site.

copyright

The copyright statement.

github_url

The project's GitHub repository.

nitpicky

rtype:

bool

project

Project title.

rst_epilog

Content of the user's reStructuredText epilog, or an empty string if not set.

rst_epilog_path

Path to the user's reStructuredText epilog file, if set.

version

The project's version.

Methods Summary

append_extensions(extensions)

Append user-configured extensions to an existing list.

append_linkcheck_ignore(link_patterns)

Append URL patterns for sphinx.linkcheck.ignore to existing patterns.

append_nitpick_ignore(nitpick_ignore)

param nitpick_ignore:

append_nitpick_ignore_regex(nitpick_ignore_regex)

param nitpick_ignore_regex:

extend_intersphinx_mapping(mapping)

Extend the intersphinx_mapping dictionary with configured projects.

find_and_load()

rtype:

DocumenteerConfig

load(toml_content)

param toml_content:

Attributes Documentation

base_url#

Base root URL for the site.

The URL is obtained in this order:

  1. The base_url field of the [project] table in documenteer.toml.

  2. From importlib.metadata if [project.python] is set in documenteer.toml.

  3. Default is “”.

Return type:

str

copyright#

The copyright statement.

Default is "" if not set.

Return type:

str

github_url#

The project’s GitHub repository.

The GitHub URL is obtained in this order:

  1. The project.github_url field in documenteer.toml

  2. From importlib if the project.python table is set

  3. Default is None.

Return type:

Optional[str]

nitpicky#
Return type:

bool

project#

Project title.

Return type:

str

rst_epilog#

Content of the user’s reStructuredText epilog, or an empty string if not set.

Return type:

str

rst_epilog_path#

Path to the user’s reStructuredText epilog file, if set.

Return type:

Optional[Path]

version#

The project’s version.

The version is obtained in this order:

  1. project.version field in documenteer.toml

  2. From importlib if the project.python table is set

  3. Default is None.

Return type:

Optional[str]

Methods Documentation

append_extensions(extensions)#

Append user-configured extensions to an existing list.

Parameters:

extensions (List[str]) –

Return type:

None

append_linkcheck_ignore(link_patterns)#

Append URL patterns for sphinx.linkcheck.ignore to existing patterns.

Parameters:

link_patterns (List[str]) –

Return type:

None

append_nitpick_ignore(nitpick_ignore)#
Parameters:

nitpick_ignore (List[Tuple[str, str]]) –

Return type:

None

append_nitpick_ignore_regex(nitpick_ignore_regex)#
Parameters:

nitpick_ignore_regex (List[Tuple[str, str]]) –

Return type:

None

extend_intersphinx_mapping(mapping)#

Extend the intersphinx_mapping dictionary with configured projects.

Parameters:

mapping (MutableMapping[str, Tuple[str, Optional[str]]]) –

Return type:

None

classmethod find_and_load()#
Return type:

DocumenteerConfig

classmethod load(toml_content)#
Parameters:

toml_content (str) –

Return type:

DocumenteerConfig