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 Distributions
Hashes for mpl_sphinx_theme-0.0.2-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e7463b4005a0b9dfe193970255934bbf288b50db109d0e712a3d4c918b1c2cb7 |
|
| MD5 | 7ccbfe014379fcc20fe3154116a5a5b9 |
|
| BLAKE2b-256 | 1325e3ea9d3e2af7dc4d9ee60cf1792fa457524d140d2d13b1b17680f1ee2c1e |
Hashes for mpl_sphinx_theme-0.0.2-1-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 35dcbb35b9b541bc0c46a72d7d2f48e99f750e1935a02f5bcc2f8f833763d1f0 |
|
| MD5 | 19e1492bd85cd76189fb1f827531bf38 |
|
| BLAKE2b-256 | f19c9db3435b6a49a7ad3318acc6f589f3093a2a1e9f1ded56128f533a2bc2e3 |
