Skip to main content

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

Project description

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

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for sphinx-gallery, version 0.5.0
Filename, size File type Python version Upload date Hashes
Filename, size sphinx-gallery-0.5.0.tar.gz (100.6 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page