Skip to content
master
Go to file
Code

Latest commit

Allows to disable the "Generated by Sphinx-gallery" notice
fefaea3

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
bin
 
 
doc
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.rst

Sphinx-Gallery

https://travis-ci.org/sphinx-gallery/sphinx-gallery.svg?branch=master https://ci.appveyor.com/api/projects/status/github/sphinx-gallery/sphinx-gallery?branch=master&svg=true

A Sphinx extension that builds an HTML version of any Python script and puts it into an examples gallery.

A demo of a gallery generated by Sphinx-Gallery

Who uses Sphinx-Gallery

Installation

Install via pip

You can do a direct install via pip by using:

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

$ git clone https://github.com/sphinx-gallery/sphinx-gallery
$ cd sphinx-gallery
$ pip install -r dev-requirements.txt
$ pip install -e .

Citation

If you would like to cite Sphinx-Gallery you can do so using our Zenodo deposit.

You can’t perform that action at this time.