`pydata_sphinx_theme.utils`#

General helpers for the management of config parameters.

Module Contents#

Functions#

`config_provided_by_user`(app, key)	Check if the user has manually provided the config.
`escape_ansi`(string)	Helper function to remove ansi coloring from sphinx warnings.
`get_theme_options_dict`(app)	Return theme options for the application w/ a fallback if they don't exist.
`maybe_warn`(app, msg, args, *kwargs)	Wraps the Sphinx logger to allow warning suppression.
`traverse_or_findall`(node, condition, **kwargs)	Triage node.traverse (docutils <0.18.1) vs node.findall.

Attributes#

SPHINX_LOGGER

pydata_sphinx_theme.utils.config_provided_by_user(app, key)[source]#

Check if the user has manually provided the config.

Parameters:

app (sphinx.application.Sphinx) –
key (str) –

Return type:

bool

pydata_sphinx_theme.utils.escape_ansi(string)[source]#

Helper function to remove ansi coloring from sphinx warnings.

Parameters:: string (str) –
Return type:: str

pydata_sphinx_theme.utils.get_theme_options_dict(app)[source]#

Return theme options for the application w/ a fallback if they don’t exist.

The “top-level” mapping (the one we should usually check first, and modify if desired) is app.builder.theme_options. It is created by Sphinx as a copy of app.config.html_theme_options (containing user-configs from their conf.py); sometimes that copy never occurs though which is why we check both.

Parameters:: app (sphinx.application.Sphinx) –
Return type:: Dict[str, Any]

pydata_sphinx_theme.utils.maybe_warn(app, msg, *args, **kwargs)[source]#

Wraps the Sphinx logger to allow warning suppression.

Parameters:: app (sphinx.application.Sphinx) –

pydata_sphinx_theme.utils.traverse_or_findall(node, condition, **kwargs)[source]#

Triage node.traverse (docutils <0.18.1) vs node.findall.

TODO: This check can be removed when the minimum supported docutils version for numpydoc is docutils>=0.18.1.