https://github.com/alexrockhill/sphinx-gallery

Sphinx extension for automatic generation of an example gallery

https://github.com/alexrockhill/sphinx-gallery

Repository

Sphinx extension for automatic generation of an example gallery

README.rst

==============
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 `_
* `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 `_
* `NetworkX `_
* `Optuna `_
* `Auto-sklearn `_
* `OpenML-Python `_
* `TorchIO `_
* `Neuraxle `_
* `Biotite `_
* `Apache TVM `_
* `Tonic `_
* `Radis `_

.. 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
`_. 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 `_.

Owner

GitHub Events