Skip to main content

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 --tags

After 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mpl_sphinx_theme-0.0.3.tar.gz (86.2 kB view details)

Uploaded Source

Built Distribution

mpl_sphinx_theme-0.0.3-py3-none-any.whl (47.9 kB view details)

Uploaded Python 3

File details

Details for the file mpl_sphinx_theme-0.0.3.tar.gz.

File metadata

  • Download URL: mpl_sphinx_theme-0.0.3.tar.gz
  • Upload date:
  • Size: 86.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.7.3

File hashes

Hashes for mpl_sphinx_theme-0.0.3.tar.gz
Algorithm Hash digest
SHA256 f02a2aefb6c8681abb526e940d466cb4b17e001dea9fb4bf995c71f0dcde4c71
MD5 d60c2f9b696641882cfadb9e63ff86ff
BLAKE2b-256 fa4a04f06859b84e3ea0e12ece1bd9664adaf8ad9d60813737aa8350d4f2ce71

See more details on using hashes here.

Provenance

File details

Details for the file mpl_sphinx_theme-0.0.3-py3-none-any.whl.

File metadata

  • Download URL: mpl_sphinx_theme-0.0.3-py3-none-any.whl
  • Upload date:
  • Size: 47.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.7.3

File hashes

Hashes for mpl_sphinx_theme-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 b4d3c13716e4c826c2c94eb5b693f6472b11febd3fcc07642e5e91593b176cfd
MD5 5a57ae047e8ff9dd57f686c8229ed906
BLAKE2b-256 4f962c247ad0887cb206c93fa8b18bffdb963827f7974d2fe36bd55903ae2e28

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page