A Sphinx <https://www.sphinx-doc.org/en/master/>_ extension that builds an HTML gallery of examples from any set of Python scripts. Checkout the documentation <sphinx-gallery.github.io>_ for introductions on how to use it and more...

.. tagline-end-content

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

Quickstart

Sphinx-Gallery can be used to generate an example gallery from .py files, for a library, as well as a stand-alone web page showcasing examples of a particular Python package, module, or class.

Let's get started with a simple example or checkout the documentation <sphinx-gallery.github.io>_ for introductions on how to use it and more...

Install via `pip`

.. installation-begin-content

You can do a direct install via pip by using:

.. code-block:: bash

$ pip install sphinx-gallery "sphinx>=4.0" pillow

.. important:: 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.

.. tip:: Sphinx-Gallery also has support for scraping images from Matplotlib and Matplotlib-based packages such as Seaborn. We recommend installing system optipng binaries to reduce the file sizes of the generated PNG files.

.. installation-end-content

Add examples to your docs

Let's assume simple scenario, you have a Python package with a directory structure like this:

.. code-block::

├── doc
│   ├── conf.py
│   ├── index.rst
|   ├── make.bat
│   └── Makefile
├── my_python_module
│   ├── __init__.py
│   └── mod.py
└── examples
    ├── plot_example.py
    └── README.txt (or .rst)

Enable Sphinx-Gallery by adding the following to your doc/conf.py:

.. code-block:: python

extensions = [
    ...
    'sphinx_gallery.gen_gallery',
]

# path to the examples scripts
sphinx_gallery_conf = {
    'examples_dirs': '../examples',   # path to your example scripts
    'gallery_dirs': 'auto_examples',  # path to where to save gallery generated output
}

Finally just compile your docs as usual. Sphinx-Gallery will generate reST files, adding execution outputs, and save them in auto_examples/. Add a link to auto_examples/index.rst to include the gallery in your documentation.

Who uses Sphinx-Gallery

An incomplete list:

.. projects_list_start

Apache TVM <https://tvm.apache.org/docs/tutorial/index.html>_
Astropy <https://docs.astropy.org/en/stable/generated/examples/index.html>_
auto-sklearn <https://automl.github.io/auto-sklearn/master/examples/index.html>_
Biotite <https://www.biotite-python.org/examples/gallery/index.html>_
Cartopy <https://scitools.org.uk/cartopy/docs/latest/gallery/>_
FURY <https://fury.gl/latest/auto_examples/index.html>_
pyGIMLi <https://www.pygimli.org/_examples_auto/index.html>_
HyperSpy <https://hyperspy.org/hyperspy-doc/current/>_
kikuchipy <https://kikuchipy.org>_
Matplotlib <https://matplotlib.org/stable/index.html>_
MNE-Python <https://mne.tools/stable/auto_examples/index.html>_
Nestle <http://kylebarbary.com/nestle/examples/index.html>_
NetworkX <https://networkx.org/documentation/stable/auto_examples/index.html>_
Neuraxle <https://www.neuraxle.org/stable/examples/index.html>_
Nilearn <https://nilearn.github.io/stable/auto_examples/index.html>_
OpenML <https://openml.github.io/openml-python/main/examples/index.html>_
OpenTURNS <https://openturns.github.io/openturns/latest/examples/examples.html>_
Optuna <https://optuna.readthedocs.io/en/stable/tutorial/index.html>_
PlasmaPy <https://docs.plasmapy.org/en/latest/examples.html>_
PyGMT <https://www.pygmt.org/latest/gallery/index.html>_
pyRiemann <https://pyriemann.readthedocs.io/en/latest/index.html>_
PyStruct <https://pystruct.github.io/auto_examples/index.html>_
PySurfer <https://pysurfer.github.io/>_
PyTorch tutorials <https://pytorch.org/tutorials>_
PyVista <https://docs.pyvista.org/examples/>_
pyxem <https://pyxem.readthedocs.io>_
RADIS <https://radis.readthedocs.io/en/latest/auto_examples/index.html>_
scikit-image <https://scikit-image.org/docs/dev/auto_examples/>_
scikit-learn <https://scikit-learn.org/stable/auto_examples/index.html>_
SimPEG <https://docs.simpeg.xyz/content/examples/>_
Sphinx-Gallery <https://sphinx-gallery.github.io/stable/auto_examples/index.html>_
SunPy <https://docs.sunpy.org/en/stable/generated/gallery/index.html>_
Tonic <https://tonic.readthedocs.io/en/latest/auto_examples/index.html>_
TorchIO <https://torchio.readthedocs.io/auto_examples/index.html>_

.. projects_list_end

Contributing

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

.. code-block:: console

$ pytest sphinx_gallery

How to cite

.. citation-begin-content

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

.. citation-end-content

FAQs

What is sphinx-gallery?

Is sphinx-gallery well maintained?

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

sphinx-gallery

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

Quickstart

Install via pip

Add examples to your docs

Who uses Sphinx-Gallery

Contributing

How to cite

Related posts

LDAPjs Open Source Project Decommissioned After Maintainer Receives Abusive Email

CISA Launches Vulnrichment Project as NVD Backlog Hits 10,000

Install via `pip`