A `Sphinx <https://www.sphinx-doc.org/en/master/>`_ extension that builds an HTML gallery of examples from any set of Python scripts.
A Sphinx extension that builds an HTML gallery of examples from any set of Python scripts.
Who uses Sphinx-Gallery
An incomplete list:
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 >= 4 and Pillow, which we use for scaling images.
Sphinx-Gallery has also support for scraping images from packages like Matplotlib, Seaborn, and PyVista. We recommend installing system optipng binaries to reduce the file sizes of the generated PNG files.
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 requirements.txt -r dev-requirements.txt
$ conda install graphviz # if using conda, you can get graphviz this way
$ pip install -e .
Check that you are all set by running:
$ pytest sphinx_gallery
How to cite
If you would like to cite Sphinx-Gallery you can do so using our Zenodo deposit.
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Hashes for sphinx_gallery-0.15.0-py3-none-any.whl