Registry / web-framework / sphinx-material

sphinx-material

JSON →
library0.0.36pypypiunverified

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.

web-framework
pip install sphinx-material
github ↗package ↗
INSTALL
IMPORT
SIG · SPHINX-MATERIAL
S
sphinx-material
web-frameworkpythonv0.0.36
Install
6.5s avg
Import
—
Disk
112MB
Pass rate
10/ 10
Env Coverage10 / 10
glibc
3.9–3.13
musl
3.9–3.13
Install & Compatibility
Where this runs
tested against v0.0.36 · 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
musl
py 3.10–3.95 runs
installs and imports cleanly · install 0.0s · import 0.000s · 110MB
glibc
py 3.10–3.95 runs
installs and imports cleanly · install 6.5s · import 0.000s · 110MB
112MB installed
● package 112MB
Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

html_theme
✓ html_theme = "sphinx_material"
✗ extensions.append("sphinx_material")
sphinx_material is a theme, not an extension. Use html_theme config.

Quickstart config to enable the theme.

# conf.py html_theme = 'sphinx_material' html_theme_options = { 'nav_sidebar': None, }
Debug
Known issues
gotchaTheme is not installed via extensions list; must set html_theme instead.
fix
Set html_theme = 'sphinx_material' in conf.py.
affects: all
gotchaTheme options like 'nav_sidebar' may be None to inherit defaults, but incorrect keys silently ignored.
fix
Double-check theme option spelling in docs.
affects: all
Upgrade
Version history
0.0.36latest on PyPI · released Aug 18, 2023
Audit
Dependencies
sphinxrequiredRequired to build documentation with this theme
Agent activity
2 hits · last 30 days
node
2
Resources
githubhttps://github.com/bashtage/sphinx-material ↗
packagehttps://pypi.org/project/sphinx-material/ ↗
sphinx-material — pip install sphinx-material · libregistry