sphinx-gallery 0.4.0

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

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

Who uses Sphinx-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

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 dependencies are:

• Sphinx >= 1.5 (1.8 recommended)

• Matplotlib

• Pillow

Sphinx-Gallery has also support for packages like:

• Seaborn

• Mayavi

Install as a developer

You can get the latest development source from our Github repository. You need setuptools installed in your system to install Sphinx-Gallery.

Additional to the dependencies listed above you will need to install pytest and pytest-coverage for testing.

To install everything do:

$ git clone https://github.com/sphinx-gallery/sphinx-gallery
$ cd sphinx-gallery
$ pip install -r requirements.txt
$ pip install pytest pytest-coverage
$ pip install -e .

In addition, you will need the following dependencies to build the sphinx-gallery documentation:

• Scipy

• Seaborn