Skip to main content

A Sphinx extension that builds an HTML version of any Python script and puts it into an examples gallery.

Project description

https://dev.azure.com/sphinx-gallery/sphinx-gallery/_apis/build/status/sphinx-gallery.sphinx-gallery?branchName=master https://circleci.com/gh/sphinx-gallery/sphinx-gallery.svg?style=shield https://zenodo.org/badge/DOI/10.5281/zenodo.4718153.svg

A Sphinx extension that builds an HTML version of any Python script and puts it into an examples gallery.

A demo of a gallery generated by Sphinx-Gallery

Installation

Install via pip

You can do a direct install via pip by using:

$ pip install sphinx-gallery

Sphinx-Gallery will not manage its dependencies when installing, thus you are required to install them manually. Our minimal dependency is:

  • Sphinx >= 1.8.3

Sphinx-Gallery has also support for packages like:

  • Matplotlib
  • Seaborn
  • Mayavi

For much of this functionality, you will need pillow. We also recommend installing system optipng binaries to reduce the file sizes of the generated PNG files.

Citation

If you would like to cite Sphinx-Gallery you can do so using our Zenodo deposit.

Project details


Download files

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

Files for sphinx-gallery, version 0.10.1
Filename, size File type Python version Upload date Hashes
Filename, size sphinx-gallery-0.10.1.tar.gz (6.5 MB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page