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.
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.
Releasing [TODO]
This project uses GitHub Actions to automatically push a new release to PyPI whenever a git tag is pushed. For example, to release a new x.y.z version of mpl-sphinx-theme, checkout the commit you would like to release, add a git tag, and push the tag to the main branch of the matplotlib/mpl-sphinx-theme repository:
$ git checkout <commit-hash>
$ git tag -a x.y.z -m 'Version x.y.z'
$ git push upstream main --tagsAfter a new release is published on PyPI, a pull request to the mpl-sphinx-theme conda-forge feedstock for the new x.y.z release will automatically be opened by conda-forge bots.
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-0.0.3-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | b4d3c13716e4c826c2c94eb5b693f6472b11febd3fcc07642e5e91593b176cfd |
|
| MD5 | 5a57ae047e8ff9dd57f686c8229ed906 |
|
| BLAKE2b-256 | 4f962c247ad0887cb206c93fa8b18bffdb963827f7974d2fe36bd55903ae2e28 |
