Install & Compatibility
Where this runs
tested against v0.7.11 · 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.514s · 97.9MB
glibcpy 3.10–3.95 runs
installs and imports cleanly · install 6.4s · import 0.486s · 98MB
99MB installed
● package 99MB
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
guzzle_sphinx_theme
✓ import guzzle_sphinx_theme
Standard import path; module name uses underscores.
guzzle_sphinx_theme.GuzzleTheme
✓ from guzzle_sphinx_theme import GuzzleTheme
✗ from guzzle_sphinx_theme import get_html_theme_path
get_html_theme_path was used in older versions but not in 0.7.11; use GuzzleTheme directly.
Basic setup for using the theme in a Sphinx project.
import guzzle_sphinx_theme
# In conf.py:
extensions = ['guzzle_sphinx_theme']
html_theme = 'guzzle_sphinx_theme'
html_theme_path = guzzle_sphinx_theme.html_theme_path()
html_theme_options = {
'project_nav_name': 'My Project',
'project_nav_url': 'https://example.com',
}
# Alternatively, use the class:
from guzzle_sphinx_theme import GuzzleTheme
html_theme = 'guzzle_sphinx_theme'
html_theme_path = [GuzzleTheme.html_theme_path()]
Errors
Common errors & fixes
Theme 'guzzle_sphinx_theme' not found. Please install it.
The theme is not installed or is not properly configured in conf.py.
fixRun 'pip install guzzle-sphinx-theme' and ensure html_theme is set correctly.
ModuleNotFoundError: No module named 'guzzle_sphinx_theme'
The import uses hyphens instead of underscores, e.g., import guzzle-sphinx-theme.
fixUse import guzzle_sphinx_theme (with underscores).
Upgrade
Version history
0.7.11latest on PyPI · released Sep 9, 2015
Audit
Dependencies
sphinxrequiredRequired to use the theme