{"id":24623,"library":"sphinx-material","title":"Sphinx Material","description":"A Sphinx theme based on Google's Material Design. Current version 0.0.36, compatible with Python >=3.6. Development is sporadic with minor bugfix releases.","status":"active","version":"0.0.36","language":"python","source_language":"en","source_url":"https://github.com/bashtage/sphinx-material","tags":["sphinx","documentation","theme","material"],"install":[{"cmd":"pip install sphinx-material","lang":"bash","label":"Install from PyPI"}],"dependencies":[{"reason":"Required to build documentation with this theme","package":"sphinx","optional":false}],"imports":[{"note":"sphinx_material is a theme, not an extension. Use html_theme config.","wrong":"extensions.append(\"sphinx_material\")","symbol":"html_theme","correct":"html_theme = \"sphinx_material\""}],"quickstart":{"code":"# conf.py\nhtml_theme = 'sphinx_material'\nhtml_theme_options = {\n    'nav_sidebar': None,\n}\n","lang":"python","description":"Quickstart config to enable the theme."},"warnings":[{"fix":"Set html_theme = 'sphinx_material' in conf.py.","message":"Theme is not installed via extensions list; must set html_theme instead.","severity":"gotcha","affected_versions":"all"},{"fix":"Double-check theme option spelling in docs.","message":"Theme options like 'nav_sidebar' may be None to inherit defaults, but incorrect keys silently ignored.","severity":"gotcha","affected_versions":"all"}],"env_vars":null,"last_verified":"2026-05-01T00:00:00.000Z","next_check":"2026-07-30T00:00:00.000Z","problems":[{"fix":"pip install sphinx-material","cause":"sphinx-material package not installed or not in Python path.","error":"Configuration error: unknown theme 'sphinx_material'"},{"fix":"Remove 'extensions.append(\"sphinx_material\")' and set html_theme = 'sphinx_material'.","cause":"Mistakenly trying to import the theme as a Python module instead of using html_theme.","error":"ImportError: cannot import name 'sphinx_material' from 'sphinx_material'"}],"ecosystem":"pypi","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}