A Sphinx extension that builds an HTML version of any Python script and puts it into an examples gallery.
Project description
A Sphinx extension that builds an HTML version of any Python script and puts it into an examples 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.
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 .
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.