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 dependencies are:
Sphinx >= 1.8.3
Matplotlib
Pillow
Sphinx-Gallery has also support for packages like:
Seaborn
Mayavi
Install as a developer
You can get the latest development source from our Github repository. You need setuptools installed in your system to install Sphinx-Gallery.
Additional to the dependencies listed above you will need to install pytest and pytest-coverage for testing.
To install everything do:
$ git clone https://github.com/sphinx-gallery/sphinx-gallery
$ cd sphinx-gallery
$ pip install -r requirements.txt
$ pip install pytest pytest-coverage
$ pip install -e .
In addition, you will need the following dependencies to build the sphinx-gallery documentation:
Scipy
Seaborn
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.