Matplotlib的Sphinx主题
项目描述
这是Matplotlib文档的官方Sphinx主题。它扩展了pydata-sphinx-theme项目，但增加了自定义样式和导航栏。
使用主分支构建的主题示例可以在https://matplotlib.net.cn/mpl-sphinx-theme/查看。
在创建Matplotlib子项目时，您可以通过更改您的conf.py文件中的此行来包含此主题。
html_theme = 'mpl_sphinx_theme'并在文档安装中将mpl_sphinx_theme作为依赖项包含。
有关其他设置，请参阅docs/conf.py文件。
在pydata-sphinx-theme中，有两种主要模板替换了默认设置。
navbar_center = mpl_nav_bar.html
navbar_end = mpl_icon_links.html请注意，由于它们包含在主题初始化中，因此无需指定标志选项。标志存储在mpl_sphinx_theme/static/logo_{light,dark}.svg。
要更改顶部导航栏，编辑mpl_sphinx_theme/mpl_nav_bar.html。
要更改社交图标，编辑mpl_sphinx_theme/mpl_icon_links.html。
要更改样式，编辑mpl_sphinx_theme/static/css/style.css。
覆盖硬编码元素
此主题主要设计用于与作为主Matplotlib网站一部分的子项目一起使用（例如，[我们的速查表](https://github.com/matplotlib/cheatsheets)和[第三方软件包列表](https://github.com/matplotlib/mpl-third-party)). 因此，一些元素是硬编码的。但是，主题也可以由其他需要更改硬编码默认设置的子项目使用。以下各节解释了如何通过修改conf.py中的html_theme_options来将这些元素重置为默认值。
页眉部分链接
使用[默认pydata-sphinx-theme导航栏](https://github.com/pydata/pydata-sphinx-theme/blob/main/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/navbar-nav.html)的副本，并在html_theme_options中将'navbar_center'键设置为此HTML文件。
构建
要使用示例页面构建主题，请导航到doc/目录并运行
make html构建的HTML页面可以在doc/_build/html/中找到。
发布
此项目使用GitHub Actions自动推送新版本到PyPI，每当发布新版本时。
例如，要发布mpl-sphinx-theme的新版本3.9.0
请确保编辑
mpl_sphinx_theme/_version.py检出您要发布的提交
添加git标签
将标签推送到
matplotlib/mpl-sphinx-theme存储库
$ git checkout <commit-hash>
$ git tag -s -a v3.9.0 -m 'REL: 3.9.0'
$ git push upstream --tags最后，将标签转换为GitHub发布。
更新以下文件中的所需mpl-sphinx-theme版本
matplotlib/matplotlib: requirements/doc/doc-requirements.txt
matplotlib/mpl-brochure-site: requirements.txt
matplotlib/mpl-third-party: docs/requirements.txt
matplotlib/governance: requirements-doc.txt
matplotlib/mpl-gui: requirements-doc.txt
下载文件
下载适合您平台的文件。如果您不确定选择哪个，请了解有关安装包的更多信息。
源分布
构建分布
mpl_sphinx_theme-3.9.0.tar.gz的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 439b748361c3f9327cf4114683f8dae4d5bbe810df888973f57096d4d9a9a524 |
|
| MD5 | 43a9ef0ea6a049d77f0f211b08c5fb57 |
|
| BLAKE2b-256 | bc74c8cb49a1a863da4e0004d34f0a0071c0408b433fb7160115bc312d63a7da |
mpl_sphinx_theme-3.9.0-py3-none-any.whl的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 821e2e96823f87519b25578a4212a50c370be623f795a516213c9d7e7cc429ed |
|
| MD5 | 1d04068dcb8ea9913811bf9c422540b1 |
|
| BLAKE2b-256 | 8fef824dc2e2fec88f98b5803bd4fb273816180307dbdbb9c36cfa01e0128f32 |