sphinx_unbloated_theme Package¶
Summary¶
Functions
Return the directory containing the theme’s AutoAPI templates. |
|
Register the theme and navigation hook with Sphinx. |
Constants
Installed theme directory containing templates, static assets, and options. |
Description¶
Sphinx Unbloated Theme, an HTML theme for Sphinx.
Package Details¶
- sphinx_unbloated_theme.get_autoapi_templates_dir()[source]¶
Return the directory containing the theme’s AutoAPI templates.
- Returns:
- str
Absolute directory path for Sphinx’s
autoapi_template_dirsetting.
Notes
This helper performs no filesystem writes and does not enable AutoAPI. Install and configure
sphinx-autoapiseparately in the consuming project.
- sphinx_unbloated_theme.setup(app)[source]¶
Register the theme and navigation hook with Sphinx.
- Parameters:
- appsphinx.application.Sphinx
Sphinx application for the documentation build.
- Returns:
- dict
Extension metadata with the version and parallel build safety flags.
Notes
Registers the core CSS before adapter styles, deferred AutoAPI and version scripts, and the page-context hook. Sphinx calls this entry point; consumers normally select
html_themerather than calling it themselves.
- sphinx_unbloated_theme.THEME_PATH¶
Installed theme directory containing templates, static assets, and options.