sphinx-immaterial
Adaptation of mkdocs-material theme for the Sphinx documentation system
Decision gist · record as of 2026-08-14
Yes, if you need a modern Sphinx theme with Material Design. The package is actively maintained, has low install friction, carries a permissive MIT license, and integrates well with Sphinx's standard extension ecosystem. The beta status (pre-1.0) means breaking changes are possible, but the current version is marked production-stable and has been in active use. No known security vulnerabilities.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Python 3.10 or later; Sphinx must be installed and configured with a conf.py file.
- Low install friction with a pure-Python wheel distribution.
- Actively maintained as of August 2026 with regular updates tracking the upstream mkdocs-material repository.
License · maintenance · safety
permissive license (permissive) — MIT-licensed core with additional Creative Commons and GNU FDL components for bundled reference data. Permissive license allows commercial and private use with attribution; derivative works permitted under the same terms.
last release 2026-02-06 (189 days) · last repo commit 2026-08-01 · 259 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 270,549 downloads/mo, #8,233 on PyPI
Alternatives
Verify before relying
pip install sphinx-immaterial
# In conf.py:
extensions = ["sphinx_immaterial"]
html_theme = 'sphinx_immaterial'- Whether breaking changes remain likely before a 1.0 release (description notes beta status but version is 0.13.9)
- Performance characteristics with large documentation sets or complex API documentation
- Extent of customization options beyond Jinja template block overrides
What it is and what it does
Sphinx-Immaterial is a Sphinx theme that brings the Material Design visual language to Sphinx-generated documentation. It adapts the popular mkdocs-material theme's HTML templates, JavaScript, and styles for use with Sphinx, the standard documentation tool for Python projects. The theme is regularly synchronized with upstream mkdocs-material to stay current with design updates.
The theme adds Sphinx-specific styling for API documentation (class and function descriptions) that mkdocs-material lacks, and implements search using Sphinx's native index format rather than lunr.js. It is installed as a Sphinx extension and configured by setting the html_theme variable in conf.py. Customization is supported through Jinja template block overrides placed in a project's _templates directory.
Use it for
- Building modern, responsive documentation for Python libraries and frameworks with Material Design aesthetics
- Migrating from mkdocs-material to Sphinx while preserving visual consistency and user experience
- Styling API reference documentation with built-in support for Sphinx object descriptions (classes, functions, modules)
- Creating branded documentation sites that integrate search, navigation, and custom header/footer elements via template overrides
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes, if you need a modern Sphinx theme with Material Design.
The package is actively maintained, has low install friction, carries a permissive MIT license, and integrates well with Sphinx's standard extension ecosystem. The beta status (pre-1.0) means breaking changes are possible, but the current version is marked production-stable and has been in active use. No known security vulnerabilities.
Install
sphinx-immaterial on PyPI
Before you install
Low install friction with a pure-Python wheel distribution. Actively maintained as of August 2026 with regular updates tracking the upstream mkdocs-material repository. Requires Python 3.10 or later.
Requires Python 3.10 or later; Sphinx must be installed and configured with a conf.py file.
License in practice
MIT-licensed core with additional Creative Commons and GNU FDL components for bundled reference data. Permissive license allows commercial and private use with attribution; derivative works permitted under the same terms.
Quickstart
pip install sphinx-immaterial
# In conf.py:
extensions = ["sphinx_immaterial"]
html_theme = 'sphinx_immaterial'Verify before relying
- Whether breaking changes remain likely before a 1.0 release (description notes beta status but version is 0.13.9)
- Performance characteristics with large documentation sets or complex API documentation
- Extent of customization options beyond Jinja template block overrides
Package facts
| License | permissive license permissive |
| Python support | Supports the current Python release >=3.10 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 7 packagessphinxmarkupsafepydanticpydantic-extra-typestyping-extensionsappdirsrequests |
| Maintenance | Actively maintained 189 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 270,549 / month, #8,233 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Development Status :: 5 - Production/StableFramework :: Sphinx :: ExtensionFramework :: Sphinx :: ThemeIntended Audience :: DevelopersLicense :: OSI Approved :: MIT LicenseNatural Language :: EnglishProgramming Language :: PythonTopic :: Documentation :: Sphinx |
Evidence: sphinx_immaterial-0.13.9-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “sphinx theme material design”
- sphinx-immaterialA Sphinx documentation theme that adapts the Material Design…
- qt-materialApplies a Material Design stylesheet to PySide6 and PyQt6…
- sphinx-rtd-themeA Sphinx theme that renders documentation with a responsive,…
Give your agent the search over MCP, or paste the wish link into any chat.
More Sphinx packages
Parses Python docstrings in ReST, Google, Numpydoc, and Epydoc formats, extracting structured information like descriptions, parameters, return types, and exceptions.
Install it if you need to programmatically read and extract structured data from Python docstrings.
Sphinx generates professional documentation from reStructuredText source files, producing HTML, PDF, EPUB, and other formats with automatic cross-references, code highlighting, and hierarchical navigation.
A Sphinx extension that outputs documentation in serialized HTML formats (JSON and pickle) alongside standard HTML.
Alabaster is a clean, responsive Sphinx theme for documentation that requires Python 3.10 or newer and Sphinx 6.2 or newer.
A Sphinx extension that generates HTML help files from reStructuredText documentation source.
A Sphinx extension that converts documentation source files into QtHelp format, enabling integration with Qt-based help systems and documentation viewers.
However, be aware that maintenance is dormant—if you rely on it long-term, monitor Sphinx compatibility and consider whether QtHelp remains the right format for your…
See also mkdocs-material · sphinx-press-theme · sphinx-bootstrap-theme · Pallets-Sphinx-Themes · sphinx-rtd-theme · furo · sphinx_design · shibuya · mkdocs-material-extensions · fig2sketch