sphinx-gallery

by sphinx-gallery

sphinx-gallery / sphinx-gallery

Sphinx extension for automatic generation of an example gallery

219 Stars 125 Forks Last release: about 1 month ago (v0.8.1) BSD 3-Clause "New" or "Revised" License 1.2K Commits 33 Releases

Available items

No Items, yet!

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:

==============

Sphinx-Gallery

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

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 
    _

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

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.