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.

See the docs/conf.py file for other settings.

Releasing

Manually for now… see the todo below for how we hope to eventually do it automagically.

$ git checkout <commit-hash>
$ git tag -a x.y.z -m 'Version x.y.z'
$ git push upstream main --tags
$ python -m build -s -w
$ twine upload dist/mpl_sphinx_theme-x.y.z*

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:

TODO: 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.4.tar.gz (72.9 kB view details)

Uploaded Source

Built Distribution

mpl_sphinx_theme-0.0.4-py3-none-any.whl (49.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mpl_sphinx_theme-0.0.4.tar.gz
  • Upload date:
  • Size: 72.9 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.4.tar.gz
Algorithm Hash digest
SHA256 905a736a5350d548b5d0129389918c85f9e9999f047874290c4cf6751c5de603
MD5 0c545fdb798ffebb248d73bb4af003b1
BLAKE2b-256 c86d9f40532e73218b1bffc35ecf3572ac3c03d7b3c2fb2e4359b76b389ce124

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: mpl_sphinx_theme-0.0.4-py3-none-any.whl
  • Upload date:
  • Size: 49.6 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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 ed8e2aa221a4a3e224f10c98dcf90d7d443b88bf0e7a7981c210dec6c81421aa
MD5 ed103e747dc61a4b9f1720d4f2e15394
BLAKE2b-256 6bce8046e674489124e4a6388c3023c4800559547260361c073f9e7de55f5fea

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