A `Sphinx <https://www.sphinx-doc.org/en/master/>`_ extension that builds an HTML gallery of examples from any set of Python scripts.
.. image:: https://img.shields.io/pypi/v/sphinx-gallery :target: https://pypi.org/project/sphinx-gallery/ :alt: PyPI
.. image:: https://img.shields.io/conda/vn/conda-forge/sphinx-gallery :target: https://anaconda.org/conda-forge/sphinx-gallery :alt: Conda-forge
.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3741780.svg :target: https://doi.org/10.5281/zenodo.3741780 :alt: Zenodo DOI
.. 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 :alt: Azure CI status
.. image:: https://circleci.com/gh/sphinx-gallery/sphinx-gallery.svg?style=shield :target: https://circleci.com/gh/sphinx-gallery/sphinx-gallery :alt: CircleCI status
.. image:: https://codecov.io/github/sphinx-gallery/sphinx-gallery/badge.svg?branch=master&service=github( :target: https://app.codecov.io/github/sphinx-gallery/sphinx-gallery :alt: Code coverage
.. tagline-begin-content
A Sphinx <https://www.sphinx-doc.org/en/master/>_ extension that builds an
HTML gallery of examples from any set of Python scripts.
.. tagline-end-content
.. image:: doc/_static/demo.png :width: 80% :alt: A demo of a gallery generated by 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>_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/>_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
pip.. installation-begin-content
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 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.
.. installation-end-content
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
.. 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