Welcome to CITSQ documentation!

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

Sphinx-Gallery is a Sphinx extension that builds an HTML gallery of examples from any set of Python scripts.

A demo of a gallery generated by Sphinx-Gallery

The code of the project is on Github: Sphinx-Gallery


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

You will also need to install the dependencies listed above and pytest

To install everything do:

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

In addition, you will need the following dependencies to build the sphinx-gallery documentation:

  • Scipy
  • Seaborn

Indices and tables