Welcome to CITSQ documentation!¶
Sphinx-Gallery is a Sphinx extension that builds an HTML
gallery of examples from any set of Python scripts.
The code of the project is on Github: Sphinx-Gallery
Features of Sphinx-Gallery¶
- create_simple_gallery by automatically running Python files, capturing outputs + figures, and rendering them into rST files ready for Sphinx when you build the documentation. Learn how to set_up_your_project
- embedding_rst, allowing you to interweave narrative-like content with code that generates plots in your documentation. Sphinx-Gallery also automatically generates a Jupyter Notebook for each your example page.
- references_to_examples. Sphinx-Gallery can generate mini-galleries listing all examples that use a particular function/method/etc.
- link_to_documentation. Sphinx-Gallery can automatically add links to API documentation for functions/methods/classes that are used in your examples (for any Python module that uses intersphinx).
- multiple_galleries_config to create and embed galleries for several folders of examples.
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
- 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