DocumenteerConfig¶
- class documenteer.conf.DocumenteerConfig(conf)¶
Bases:
object
Configuration from a documenteer.toml file.
- Parameters:
conf (
ConfigRoot
)
Attributes Summary
Base root URL for the site.
The copyright statement.
The project's GitHub repository.
Number of links to show in the nav head before folding extra items into a More dropdown.
Project title.
Redirects defined in the [sphinx.redirects] TOML configuration.
Content of the user's reStructuredText epilog, or an empty string if not set.
Path to the user's reStructuredText epilog file, if set.
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)append_nitpick_ignore_regex
(nitpick_ignore_regex)disable_primary_sidebars
(html_sidebars)extend_exclude_patterns
(exclude_patterns)Extend Sphinx
exclude_patterns
with the "exclude" configuration from the sphinx TOML table.extend_intersphinx_mapping
(mapping)Extend the
intersphinx_mapping
dictionary with configured projects.load
(toml_content)set_edit_on_github
(html_theme_options, ...)Configure the Edit on GitHub functionality, if possible.
Attributes Documentation
- automodapi_toctreedirm¶
- base_url¶
Base root URL for the site.
The URL is obtained in this order:
The
base_url
field of the[project]
table in documenteer.toml.From importlib.metadata if
[project.python]
is set in documenteer.toml.Default is “”.
- copyright¶
The copyright statement.
Default is
""
if not set.
- github_url¶
The project’s GitHub repository.
The GitHub URL is obtained in this order:
The project.github_url field in
documenteer.toml
From importlib if the project.python table is set
Default is None.
- header_links_before_dropdown¶
Number of links to show in the nav head before folding extra items into a More dropdown.
- nitpicky¶
- project¶
Project title.
- redirects¶
Redirects defined in the [sphinx.redirects] TOML configuration.
- 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.
The version is obtained in this order:
project.version field in
documenteer.toml
From importlib if the project.python table is set
Default is “Latest”.
Methods Documentation
- 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)¶
- append_nitpick_ignore_regex(nitpick_ignore_regex)¶
- disable_primary_sidebars(html_sidebars)¶
- Parameters:
html_sidebars (
MutableMapping
[str
,list
[str
]])- Return type:
- extend_exclude_patterns(exclude_patterns)¶
Extend Sphinx
exclude_patterns
with the “exclude” configuration from the sphinx TOML table.
- extend_intersphinx_mapping(mapping)¶
Extend the
intersphinx_mapping
dictionary with configured projects.
- classmethod find_and_load()¶
- Return type:
- set_edit_on_github(html_theme_options, html_context)¶
Configure the Edit on GitHub functionality, if possible.
- Parameters:
html_theme_options (
MutableMapping
[str
,Any
])html_context (
MutableMapping
[str
,Any
])
- Return type: