Guzzle Sphinx Theme

0.7.11 verified Fri May 01 auth: no python maintenance

A Sphinx theme originally created for the Guzzle PHP project documentation. The current version (0.7.11) is quite old and the project appears to be in maintenance mode. It provides a clean, responsive theme suitable for documentation sites. No major changes have been made recently, and there are no known breaking changes between versions.

pip install guzzle-sphinx-theme

Common errors

error Theme 'guzzle_sphinx_theme' not found. Please install it. ↓

cause The theme is not installed or is not properly configured in conf.py.

fix

Run 'pip install guzzle-sphinx-theme' and ensure html_theme is set correctly.

error ModuleNotFoundError: No module named 'guzzle_sphinx_theme' ↓

cause The import uses hyphens instead of underscores, e.g., import guzzle-sphinx-theme.

fix

Use import guzzle_sphinx_theme (with underscores).

Warnings

gotcha The theme uses underscores in the module name: guzzle_sphinx_theme, not guzzle-sphinx-theme. Incorrect import leads to ModuleNotFoundError. ↓

fix Use import guzzle_sphinx_theme

deprecated The function guzzle_sphinx_theme.get_html_theme_path() may not work correctly in newer Sphinx versions; prefer using the GuzzleTheme class. ↓

fix Use from guzzle_sphinx_theme import GuzzleTheme; html_theme_path = [GuzzleTheme.html_theme_path()]

Imports

guzzle_sphinx_theme
```
import guzzle_sphinx_theme
```
Standard import path; module name uses underscores.
guzzle_sphinx_theme.GuzzleTheme
wrong
```
from guzzle_sphinx_theme import get_html_theme_path
```
correct
```
from guzzle_sphinx_theme import GuzzleTheme
```
get_html_theme_path was used in older versions but not in 0.7.11; use GuzzleTheme directly.

Quickstart

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()]