============== Sphinx-Gallery

.. image:: https://dev.azure.com/sphinx-gallery/sphinx-gallery/_apis/build/status/sphinx-gallery.sphinx-gallery?branchName=master :target: https://dev.azure.com/sphinx-gallery/sphinx-gallery/_build/latest?definitionId=1&branchName=master

.. image:: https://circleci.com/gh/sphinx-gallery/sphinx-gallery.svg?style=shield :target: https://circleci.com/gh/sphinx-gallery/sphinx-gallery

.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.4718153.svg :target: https://doi.org/10.5281/zenodo.4718153

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

.. image:: doc/_static/demo.png :width: 80% :alt: A demo of a gallery generated by Sphinx-Gallery

Who uses Sphinx-Gallery

• Sphinx-Gallery <https://sphinx-gallery.github.io/stable/auto_examples/index.html>_
• Scikit-learn <http://scikit-learn.org/dev/auto_examples/index.html>_
• Nilearn <https://nilearn.github.io/auto_examples/index.html>_
• MNE-python <https://www.martinos.org/mne/stable/auto_examples/index.html>_
• PyStruct <https://pystruct.github.io/auto_examples/index.html>_
• GIMLi <http://www.pygimli.org/_examples_auto/index.html>_
• Nestle <https://kbarbary.github.io/nestle/examples/index.html>_
• pyRiemann <https://pyriemann.readthedocs.io/en/latest/index.html>_
• scikit-image <http://scikit-image.org/docs/dev/auto_examples/>_
• Astropy <http://docs.astropy.org/en/stable/generated/examples/index.html>_
• SunPy <http://docs.sunpy.org/en/stable/generated/gallery/index.html>_
• PySurfer <https://pysurfer.github.io/>_
• Matplotlib <https://matplotlib.org/index.html>_ Examples <https://matplotlib.org/gallery/index.html>_ and Tutorials <https://matplotlib.org/tutorials/index.html>__
• PyTorch tutorials <http://pytorch.org/tutorials>_
• Cartopy <http://scitools.org.uk/cartopy/docs/latest/gallery/>_
• PyVista <https://docs.pyvista.org/examples/>_
• SimPEG <http://docs.simpeg.xyz/content/examples/>_
• PlasmaPy <https://docs.plasmapy.org/en/latest/examples.html>_
• Fury <http://fury.gl/latest/auto_examples/index.html>_
• NetworkX <https://networkx.github.io/documentation/stable/auto_examples/index.html>_
• Optuna <https://optuna.readthedocs.io/en/stable/tutorial/index.html>_
• Auto-sklearn <https://automl.github.io/auto-sklearn/master/examples/index.html>_
• OpenML-Python <https://openml.github.io/openml-python/main/examples/index.html>_
• TorchIO <https://torchio.readthedocs.io/auto_examples/index.html>_
• Neuraxle <https://www.neuraxle.org/stable/examples/index.html>_
• Biotite <https://www.biotite-python.org/examples/gallery/index.html>_
• Apache TVM <https://tvm.apache.org/docs/tutorial/index.html>_
• Tonic <https://tonic.readthedocs.io/en/latest/auto_examples/index.html>_
• Radis <https://radis.readthedocs.io/en/latest/auto_examples/index.html>_

.. installation-begin-content

Installation

Install via pip

You can do a direct install via pip by using:

.. code-block:: bash

$ 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.

Install as a Sphinx-Gallery developer

You can get the latest development source from our Github repository <https://github.com/sphinx-gallery/sphinx-gallery>_. You need setuptools installed in your system to install Sphinx-Gallery. For example, you can do:

.. code-block:: console

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

.. installation-end-content

Citation

If you would like to cite Sphinx-Gallery you can do so using our Zenodo deposit <https://zenodo.org/record/3838216>_.