Adaptation of mkdocs-material theme for the Sphinx documentation system
Project description
This theme is an adaptation of the popular mkdocs-material theme for the Sphinx documentation tool.
This theme is regularly maintained to stay up to date with the upstream mkdocs-material repository. The HTML templates, JavaScript, and styles from the mkdocs-material theme are incoroprated directly with mostly minor modifications.
This theme is a fork of the sphinx-material theme, which proved the concept of a Sphinx theme based on an earlier version of the mkdocs-material theme, but has now significantly diverged from the upstream mkdocs-material repository.
See the TensorStore documentation for a demonstration of this theme.
WARNING: This theme is currently still a work in progress. The documentation is largely copied from sphinx-material and is inaccurate for this version. It does not yet integrate well with numpydoc or the built-in autosummary.
Installation
Install via pip:
$ pip install sphinx-immaterialor if you have the code checked out locally:
$ pip -install -e .Configuration
In your conf.py add sphinx_immaterial as an extension:
extensions = [
...,
"sphinx_immaterial"
]and add the following:
html_theme = 'sphinx_immaterial'to set the theme.
Customizing the layout
You can customize the theme by overriding Jinja template blocks. For example, ‘layout.html’ contains several blocks that can be overridden or extended.
Place a ‘layout.html’ file in your project’s ‘/_templates’ directory.
mkdir source/_templates
touch source/_templates/layout.htmlThen, configure your ‘conf.py’:
templates_path = ['_templates']Finally, edit your override file ‘source/_templates/layout.html’:
{# Import the theme's layout. #}
{% extends '!layout.html' %}
{%- block extrahead %}
{# Add custom things to the head HTML tag #}
{# Call the parent block #}
{{ super() }}
{%- endblock %}
Differences from mkdocs-material
This theme closely follows the upstream mkdocs-material repository, but there are a few differences, primarily due to differences between Sphinx and MkDocs:
This theme adds styles for Sphinx object descriptions, commonly used for API documentation (e.g. class and function documentation). This is a core element of Sphinx for which there is no corresponding feature in MkDocs.
mkdocs-material uses lunr.js for searching, and has custom UI components for displaying search results in a drop-down menu as you type the search query. This theme uses a separate search implementation based on the custom index format used by Sphinx, which fully integrates with the search UI provided by mkdocs-material.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file sphinx_immaterial-0.7.2.tar.gz.
File metadata
- Download URL: sphinx_immaterial-0.7.2.tar.gz
- Upload date:
- Size: 3.2 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.0 CPython/3.8.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 240c350c4f5bab5ad0a5b590c45fb83319da4a805875dc05ade9653f39b88d54 |
|
| MD5 | 246760d7a4d073c713cea8cdefb96f8b |
|
| BLAKE2b-256 | ae4cae2f8fcfd7bde8684574ab769a4408f9152c09a74c890e6ca45056595f8b |
File details
Details for the file sphinx_immaterial-0.7.2-py3-none-any.whl.
File metadata
- Download URL: sphinx_immaterial-0.7.2-py3-none-any.whl
- Upload date:
- Size: 5.1 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.0 CPython/3.8.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 43bfacde6e8839e01839759748d4e634d5a4a40b8ab1d44d860487c40c5d3821 |
|
| MD5 | 5e19e95d25808ac16c979ea879b70f97 |
|
| BLAKE2b-256 | 81b194cbbc3fcf36a04911211f0ce6a509c43525b62bd0a6ed28bf8cf0ae4b82 |
