Install & Compatibility
Where this runs
tested against v0.9.1 · 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
muslpy 3.10–3.95 runs
installs and imports cleanly · install 0.0s · import 0.430s · 92.1MB
glibcpy 3.10–3.95 runs
installs and imports cleanly · install 5.2s · import 0.420s · 93MB
94MB installed
● package 94MB
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
press
✓ import sphinx_press_theme
✗ press
The theme is not imported directly; it is configured in conf.py as 'sphinx_press_theme' via html_theme
sphinx_press_theme
✓ html_theme = 'sphinx_press_theme'
✗ html_theme = 'press' or 'sphinx-press-theme'
In Sphinx conf.py, set html_theme = 'sphinx_press_theme' (underscores, not hyphens)
Minimal setup: add the import and theme options to your Sphinx conf.py.
# conf.py
import sphinx_press_theme
html_theme = 'sphinx_press_theme'
html_theme_options = {
'repository_url': 'https://github.com/your/repo',
'repository_branch': 'main',
'home_page_title': 'My Docs',
'show_prev_next': False
}
Errors
Common errors & fixes
WARNING: html_theme 'sphinx_press_theme' not found
The theme package is not installed or the name is misspelled in conf.py.
fixRun 'pip install sphinx-press-theme' and ensure html_theme = 'sphinx_press_theme' (underscores).
ModuleNotFoundError: No module named 'sphinx_press_theme'
The import is incorrect when using autodoc or similar; no need to import in conf.py for theme only.
fixRemove the import statement; Sphinx will load the theme automatically if html_theme is set correctly.
Upgrade
Version history
0.9.1latest on PyPI · released Mar 23, 2024
Audit
Dependencies
sphinxrequiredRequired; the theme is a Sphinx extension