Matplotlib theme for Sphinx
Project description
This is the official Sphinx theme for Matplotlib documentation. It extends the pydata-sphinx-theme project, but adds custom styling and a navigation bar.
A demo of the theme built with the main branch can be seen at https://matplotlib.org/mpl-sphinx-theme/.
When creating a Matplotlib subproject you can include this theme by changing this line in your conf.py file
html_theme = 'mpl_sphinx_theme'And by including mpl_sphinx_theme as a requirement in your documentation installation.
See the docs/conf.py file for other settings.
There are two main templates that replace the defaults in pydata-sphinx-theme:
navbar_center = mpl_nav_bar.html
navbar_end = mpl_icon_links.htmlNote that the logo options need not be specified as they are included in theme initialization. The logo is stored at mpl_sphinx_theme/static/logo_{light,dark}.svg.
To change the top navbar, edit mpl_sphinx_theme/mpl_nav_bar.html
To change the social icons, edit mpl_sphinx_theme/mpl_icon_links.html
To change the style, edit mpl_sphinx_theme/static/css/style.css
Overriding hard coded elements
This theme is primarily designed to be used with subprojects that are part of the main Matplotlib webiste (e.g., [our cheatseets](https://github.com/matplotlib/cheatsheets] and [list of third-party packages](https://github.com/matplotlib/mpl-third-party)). As such several elements are hard coded. However, the theme may also be used by other subprojects that need to change the hard-coded defaults. The following sections explain how to reset these back to their defaults by modifying html_theme_options in conf.py.
Header section links
Use a copy of [the default pydata-sphinx-theme navbar](https://github.com/pydata/pydata-sphinx-theme/blob/main/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/navbar-nav.html) and set the 'navbar_center' key to this HTML file in html_theme_options.
Building
To build the theme with a sample page, navigate into the doc/ directory and run
make htmlThe built html pages can be found in doc/_build/html/
Releasing
This project uses GitHub Actions to automatically push a new release to PyPI whenever a release is made.
For example, to release a new 3.9.0 version of mpl-sphinx-theme:
be sure to edit mpl_sphinx_theme/_version.py
checkout the commit you would like to release
add a git tag
push the tag to the matplotlib/mpl-sphinx-theme repository
$ git checkout <commit-hash>
$ git tag -s -a v3.9.0 -m 'REL: 3.9.0'
$ git push upstream --tagsFinally, turn the tag into a GitHub release.
Update the required mpl-sphinx-theme version in the following files:
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
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
Hashes for mpl_sphinx_theme-3.9.0rc1.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | eff49e0cd90a8e9e6e97ee1a70696461c3d871ec5e19653903dd3fce229e2dee |
|
| MD5 | c18952bc3e847f5e89ffecd04741c758 |
|
| BLAKE2b-256 | e3561acbefa6be1d3faa1ed71566dff7a8e88ef3c5922d2bbb72f0e31cba8fa0 |
Hashes for mpl_sphinx_theme-3.9.0rc1-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 3526063ca5b53bff5b954a19f922953a2bec9536fb638e5a0ac4370471f1317c |
|
| MD5 | 299ca2082f78569fe779f1df72fa4881 |
|
| BLAKE2b-256 | 1eb02d2273da37a89dd8ef1c16ab5b09f500693ca2763bb9c11aef89e85fe641 |
