{"id":24627,"library":"sphinxawesome-theme","title":"sphinxawesome-theme","description":"An awesome theme for the Sphinx documentation generator. Current version 6.0.2. Released irregularly.","status":"active","version":"6.0.2","language":"python","source_language":"en","source_url":"https://github.com/kai687/sphinxawesome-theme","tags":["sphinx","theme","documentation"],"install":[{"cmd":"pip install sphinxawesome-theme","lang":"bash","label":"Install from PyPI"}],"dependencies":[{"reason":"Core dependency; theme requires Sphinx >=5.0","package":"sphinx","optional":false}],"imports":[{"note":"In v6.x, the extension function is configure_theme, not setup.","wrong":"from sphinxawesome_theme import setup","symbol":"configure_theme","correct":"from sphinxawesome_theme import configure_theme"}],"quickstart":{"code":"# conf.py\nfrom sphinxawesome_theme import configure_theme\n\nextensions = ['sphinxawesome_theme']\n\nconfigure_theme(globals())\n\nhtml_theme = 'sphinxawesome_theme'","lang":"python","description":"Add the above to your Sphinx conf.py to use the theme."},"warnings":[{"fix":"Update imports to `from sphinxawesome_theme import configure_theme` and call `configure_theme(globals())`.","message":"Upgrading from older versions may break due to changed import path: use `from sphinxawesome_theme import configure_theme` instead of `sphinxawesome_theme.setup`","severity":"breaking","affected_versions":"<6.0.0"},{"fix":"Pass theme options directly to `configure_theme()` or use `html_theme_options` if still supported, but check docs.","message":"The `html_theme_options` dict is deprecated in favor of `configure_theme(globals(), ...)` keyword arguments.","severity":"deprecated","affected_versions":"6.x"},{"fix":"Ensure Python version is >=3.10 before installing.","message":"Python >=3.10 is required. Installing on older Python versions silently fails with an incompatible version error.","severity":"gotcha","affected_versions":"6.0.0+"}],"env_vars":null,"last_verified":"2026-05-01T00:00:00.000Z","next_check":"2026-07-30T00:00:00.000Z","problems":[{"fix":"Install: `pip install sphinxawesome-theme`. Then add `'sphinxawesome_theme'` to the `extensions` list in conf.py.","cause":"Failed to install the package or forgot to add it to extensions.","error":"ModuleNotFoundError: No module named 'sphinxawesome_theme'"},{"fix":"Ensure 'sphinxawesome_theme' is in `extensions` and the package is installed.","cause":"Typo in extension name or missing from requirements.","error":"Exception: Extension 'sphinxawesome_theme' not found"}],"ecosystem":"pypi","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}