Registry / web-framework / sphinxawesome-theme

sphinxawesome-theme

JSON →

library6.0.5pypypiunverified

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

web-framework

pip install sphinxawesome-theme

github ↗package ↗homepage ↗docs ↗

INSTALL

IMPORT

SIG · SPHINXAWESOME-THEM

sphinxawesome-theme

web-frameworkpythonv6.0.5

Install

5.5s avg

Import

—

Disk

96MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v6.0.5 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.95 runs

installs and imports cleanly · install 0.0s · import 0.000s · 93.9MB

glibc

py 3.10–3.95 runs

installs and imports cleanly · install 5.5s · import 0.000s · 94MB

96MB installed

● package 96MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

configure_theme

✓ from sphinxawesome_theme import configure_theme

✗ from sphinxawesome_theme import configure_theme

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'

Debug

Known issues

breakingUpgrading 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())`.

affects: <6.0.0

deprecatedThe `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.

affects: 6.x

gotchaPython >=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.

affects: 6.0.0+

Upgrade

Version history

6.0.5latest on PyPI · released Jun 15, 2026

Audit

Dependencies

sphinxrequiredCore dependency; theme requires Sphinx >=5.0

Agent activity

13 hits · last 30 days

node

Resources

githubhttps://github.com/kai687/sphinxawesome-theme ↗

packagehttps://pypi.org/project/sphinxawesome-theme/ ↗

homepagehttps://sphinxawesome.xyz ↗

docshttps://sphinxawesome.xyz ↗