sphinx_toolbox.config
¶
Internal configuration for sphinx-toolbox
.
Exceptions:
Subclass of |
|
Subclass of |
Classes:
|
Subclass of |
Functions:
|
Validate the provided configuration values. |
-
exception
InvalidOptionError
[source]¶ Bases:
ValueError
Subclass of
ValueError
to indicate an invalid value for a configuration value.
-
exception
MissingOptionError
[source]¶ Bases:
ValueError
Subclass of
ValueError
to indicate a missing configuration option.
-
class
ToolboxConfig
(config={}, overrides={})[source]¶ Bases:
Config
Subclass of
sphinx.config.Config
with type annotations for the configuration values added bysphinx-toolbox
.Depending on the extensions enabled not all of these configuration values will be present.
Functionally compatible with
sphinx.config.Config
.Attributes:
Document all
typing.TypeVar
s, even if they have no docstring.The directory in which to find assets for the
asset
role.List of required Conda channels.
The tab size used by docutils.
The base URL for the issues on GitHub.
The base URL for the pull requests on GitHub.
The GitHub repository this documentation corresponds to.
The base URL for the source code on GitHub.
The complete URL of the repository on GitHub.
The username of the GitHub account that owns the repository this documentation corresponds to.
Only document
typing.TypeVar
s that have a constraint of are bound.A string of reStructuredText that will be included at the beginning of every source file that is read.
The target of the source link, either
'github'
or'sphinx'
.The Wikipedia language to use for
wikipedia
roles.-
all_typevars
¶ Type:
bool
Document all
typing.TypeVar
s, even if they have no docstring.
-
docutils_tab_width
¶ Type:
int
The tab size used by docutils. This is usually 8 spaces, but can be configured in the
docutils.conf
file.
-
github_issues_url
¶ Type:
RequestsURL
The base URL for the issues on GitHub.
-
github_pull_url
¶ Type:
RequestsURL
The base URL for the pull requests on GitHub.
-
github_source_url
¶ Type:
RequestsURL
The base URL for the source code on GitHub.
-
github_url
¶ Type:
RequestsURL
The complete URL of the repository on GitHub.
-
github_username
¶ Type:
str
The username of the GitHub account that owns the repository this documentation corresponds to.
-
no_unbound_typevars
¶ Type:
bool
Only document
typing.TypeVar
s that have a constraint of are bound.This option has no effect if
all_typevars
is False.
-
rst_prolog
¶ Type:
str
A string of reStructuredText that will be included at the beginning of every source file that is read.
-
source_link_target
¶ Type:
str
The target of the source link, either
'github'
or'sphinx'
. Will be lowercase aftervalidate_config()
has run.
-
-
validate_config
(app, config)[source]¶ Validate the provided configuration values.
See
ToolboxConfig
for a list of the configuration values.- Parameters
app (
Sphinx
) – The Sphinx application.config (
Config
)