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

• Sphinx-Gallery
• Scikit-learn
• Nilearn
• MNE-python
• PyStruct
• GIMLi
• Nestle
• pyRiemann
• scikit-image
• Astropy
• SunPy
• PySurfer
• Matplotlib Examples and Tutorials
• PyTorch tutorials
• Cartopy
• PyVista
• SimPEG
• PlasmaPy
• Fury

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.

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 https://github.com/sphinx-gallery/sphinx-gallery
$ cd sphinx-gallery
$ pip install -r dev-requirements.txt
$ pip install -e .

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