Skip to main content

A `Sphinx <>`_ extension that builds an HTML gallery of examples from any set of Python scripts.

Project description

PyPI Conda-forge Zenodo DOI Azure CI status CircleCI status Code coverage

A Sphinx extension that builds an HTML gallery of examples from any set of Python scripts.

A demo of a gallery generated by Sphinx-Gallery


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 dependencies are Sphinx >= 4 and Pillow, which we use for scaling images.

Sphinx-Gallery has also support for scraping images from packages like Matplotlib, Seaborn, and PyVista. We recommend installing system optipng binaries to reduce the file sizes of the generated PNG files.


You can get the latest development source from our Github repository. You need setuptools installed in your system to install Sphinx-Gallery. For example, you can do:

$ git clone
$ cd sphinx-gallery
$ pip install -r requirements.txt -r dev-requirements.txt
$ conda install graphviz  # if using conda, you can get graphviz this way
$ pip install -e .

Check that you are all set by running:

$ pytest sphinx_gallery

How to cite

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.

Source Distribution

sphinx-gallery-0.15.0.tar.gz (422.4 kB view hashes)

Uploaded source

Built Distribution

sphinx_gallery-0.15.0-py3-none-any.whl (164.7 kB view hashes)

Uploaded py3

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