{"id":23833,"library":"guzzle-sphinx-theme","title":"Guzzle Sphinx Theme","description":"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.","status":"maintenance","version":"0.7.11","language":"python","source_language":"en","source_url":"https://github.com/guzzle/guzzle_sphinx_theme","tags":["sphinx","theme","documentation","guzzle"],"install":[{"cmd":"pip install guzzle-sphinx-theme","lang":"bash","label":"Install from PyPI"}],"dependencies":[{"reason":"Required to use the theme","package":"sphinx","optional":false}],"imports":[{"note":"Standard import path; module name uses underscores.","symbol":"guzzle_sphinx_theme","correct":"import guzzle_sphinx_theme"},{"note":"get_html_theme_path was used in older versions but not in 0.7.11; use GuzzleTheme directly.","wrong":"from guzzle_sphinx_theme import get_html_theme_path","symbol":"guzzle_sphinx_theme.GuzzleTheme","correct":"from guzzle_sphinx_theme import GuzzleTheme"}],"quickstart":{"code":"import guzzle_sphinx_theme\n\n# In conf.py:\nextensions = ['guzzle_sphinx_theme']\nhtml_theme = 'guzzle_sphinx_theme'\nhtml_theme_path = guzzle_sphinx_theme.html_theme_path()\nhtml_theme_options = {\n    'project_nav_name': 'My Project',\n    'project_nav_url': 'https://example.com',\n}\n\n# Alternatively, use the class:\nfrom guzzle_sphinx_theme import GuzzleTheme\nhtml_theme = 'guzzle_sphinx_theme'\nhtml_theme_path = [GuzzleTheme.html_theme_path()]","lang":"python","description":"Basic setup for using the theme in a Sphinx project."},"warnings":[{"fix":"Use import guzzle_sphinx_theme","message":"The theme uses underscores in the module name: guzzle_sphinx_theme, not guzzle-sphinx-theme. Incorrect import leads to ModuleNotFoundError.","severity":"gotcha","affected_versions":"all"},{"fix":"Use from guzzle_sphinx_theme import GuzzleTheme; html_theme_path = [GuzzleTheme.html_theme_path()]","message":"The function guzzle_sphinx_theme.get_html_theme_path() may not work correctly in newer Sphinx versions; prefer using the GuzzleTheme class.","severity":"deprecated","affected_versions":">=0.7.11"}],"env_vars":null,"last_verified":"2026-05-01T00:00:00.000Z","next_check":"2026-07-30T00:00:00.000Z","problems":[{"fix":"Run 'pip install guzzle-sphinx-theme' and ensure html_theme is set correctly.","cause":"The theme is not installed or is not properly configured in conf.py.","error":"Theme 'guzzle_sphinx_theme' not found. Please install it."},{"fix":"Use import guzzle_sphinx_theme (with underscores).","cause":"The import uses hyphens instead of underscores, e.g., import guzzle-sphinx-theme.","error":"ModuleNotFoundError: No module named 'guzzle_sphinx_theme'"}],"ecosystem":"pypi","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}