sphinxawesome-theme

raw JSON →

6.0.2 verified Fri May 01 auth: no python

An awesome theme for the Sphinx documentation generator. Current version 6.0.2. Released irregularly.

pip install sphinxawesome-theme

Common errors

error ModuleNotFoundError: No module named 'sphinxawesome_theme' ↓

cause Failed to install the package or forgot to add it to extensions.

fix

Install: pip install sphinxawesome-theme. Then add 'sphinxawesome_theme' to the extensions list in conf.py.

error Exception: Extension 'sphinxawesome_theme' not found ↓

cause Typo in extension name or missing from requirements.

fix

Ensure 'sphinxawesome_theme' is in extensions and the package is installed.

Warnings

breaking Upgrading from older versions may break due to changed import path: use `from sphinxawesome_theme import configure_theme` instead of `sphinxawesome_theme.setup` ↓

fix Update imports to `from sphinxawesome_theme import configure_theme` and call `configure_theme(globals())`.

deprecated The `html_theme_options` dict is deprecated in favor of `configure_theme(globals(), ...)` keyword arguments. ↓

fix Pass theme options directly to `configure_theme()` or use `html_theme_options` if still supported, but check docs.

gotcha Python >=3.10 is required. Installing on older Python versions silently fails with an incompatible version error. ↓

fix Ensure Python version is >=3.10 before installing.

Imports

configure_theme

wrong

from sphinxawesome_theme import setup

correct

from sphinxawesome_theme import configure_theme

In v6.x, the extension function is configure_theme, not setup.

Quickstart

Add the above to your Sphinx conf.py to use the theme.

# conf.py
from sphinxawesome_theme import configure_theme

extensions = ['sphinxawesome_theme']

configure_theme(globals())

html_theme = 'sphinxawesome_theme'