pydata_sphinx_theme

Bootstrap-based sphinx theme from the PyData community.

Submodules

• pydata_sphinx_theme.edit_this_page
• pydata_sphinx_theme.logo
• pydata_sphinx_theme.pygment
• pydata_sphinx_theme.short_link
• pydata_sphinx_theme.toctree
• pydata_sphinx_theme.translator
• pydata_sphinx_theme.utils

Package Contents

Functions

setup(app)	Setup the Sphinx application.
update_and_remove_templates(app, pagename, ...)	Update template names and assets for page build.
update_config(app)	Update config with new default values and handle deprecated keys.

Attributes

__version__

pydata_sphinx_theme.setup(app)

Setup the Sphinx application.

Parameters:

app (sphinx.application.Sphinx) –

Return type:

Dict[str, str]

pydata_sphinx_theme.update_and_remove_templates(app, pagename, templatename, context, doctree)

Update template names and assets for page build.

Parameters:

• app (sphinx.application.Sphinx) –

• pagename (str) –

• templatename (str) –

Return type:

None

pydata_sphinx_theme.update_config(app)

Update config with new default values and handle deprecated keys.

pydata_sphinx_theme.__version__ = '0.15.2'