Sphinx extension for automatic generation of an example gallery
The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:
.. image:: https://travis-ci.org/sphinx-gallery/sphinx-gallery.svg?branch=master :target: https://travis-ci.org/sphinx-gallery/sphinx-gallery
.. image:: https://ci.appveyor.com/api/projects/status/github/sphinx-gallery/sphinx-gallery?branch=master&svg=true :target: https://ci.appveyor.com/project/sphinx-gallery/sphinx-gallery/history
.. image:: https://zenodo.org/badge/25860190.svg :target: https://zenodo.org/badge/latestdoi/25860190
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
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-Gallery has also support for packages like:
For much of this functionality, you will need
pillow. We also recommend installing system
optipngbinaries to reduce the file sizes of the generated PNG files.
You can get the latest development source from our
Github repository_. You need
setuptoolsinstalled 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 .
If you would like to cite Sphinx-Gallery you can do so using our