mkdocs-material主题的Sphinx文档系统适配版本
项目描述
此主题是基于流行的 mkdocs-material 主题，用于 Sphinx 文档工具的适配版本。
此主题定期维护，以保持与 mkdocs-material 仓库的上游同步。从 mkdocs-material 主题直接纳入HTML模板、JavaScript和样式，大部分仅进行了小的修改。
此主题是 sphinx-material 主题的分支，该主题证明了基于较早版本的 mkdocs-material 主题的Sphinx主题概念，但现在已显著偏离了上游 mkdocs-material 仓库。
请参阅 此主题的文档 以进行演示。
警告：此主题仍处于beta测试阶段。虽然它已经非常可用，但在1.0版本发布之前仍可能进行破坏性更改。
安装
通过pip安装
$ pip install sphinx-immaterial或者如果您已经本地检出代码
$ pip install -e .配置
在您的 conf.py 中添加 sphinx_immaterial 作为扩展
extensions = [
...,
"sphinx_immaterial"
]并添加以下内容
html_theme = 'sphinx_immaterial'以设置主题。
自定义布局
您可以通过覆盖 Jinja 模板块来自定义主题。例如，‘layout.html’ 包含几个可以覆盖或扩展的块。
将‘layout.html’文件放置在您的项目目录的‘/_templates’中。
mkdir source/_templates
touch source/_templates/layout.html然后，配置您的‘conf.py’
templates_path = ['_templates']最后，编辑您的覆盖文件‘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 %}
与 mkdocs-material 的区别
此主题紧密遵循上游 mkdocs-material 仓库，但有一些区别，主要是由于 Sphinx 和 MkDocs 之间的区别
此主题为 Sphinx 对象描述添加了样式，通常用于 API 文档（例如类和函数文档）。这是 Sphinx 的核心元素，MkDocs 中没有对应的特性。
mkdocs-material 使用 lunr.js 进行搜索，并在您输入搜索查询时显示搜索结果的下拉菜单中具有自定义 UI 组件。此主题使用基于 Sphinx 使用的自定义索引格式的独立搜索实现，并与 mkdocs-material 提供的搜索 UI 完全集成。
sphinx_immaterial-0.12.2.tar.gz 的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 0c06f2b18dffc8a3ae04ce9e7f1d4a011dd4811965558a6b394484b9af2f3ec4 |
|
| MD5 | c768cdc46bc88c4567dec053fcecfa00 |
|
| BLAKE2b-256 | f48d8ed6c92ed69b57e7e2e336622ee7014dbc8befd633ed163eb8b998dc711f |
sphinx_immaterial-0.12.2-py3-none-any.whl 的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | a7317c42fac1075982b088671364daaf5fcf829ab5835cfb374d3b2496be14ee |
|
| MD5 | 26ba44b10c50702af7cbdcd1e5cd4a98 |
|
| BLAKE2b-256 | 9412ba6318536869adfac5d2ffbe7ecec1e465b999bac6324d88a8721900ff58 |
