Sphinx-Gallery

View the output here:

https://coding-to-music.github.io/sphinx-gallery/

Install these:

pip install -r dev_requirements.txt

// Which is better than installing those many programs
pip install sphinx-rtd-theme
pip install sphinx-gallery

Running into problems with the python version being called, needs to be 3.7 but it is finding Python 2.7

pip install -e .
python --version

// see what versions of python are available
locate /python | grep /bin
ls -l /usr/bin/python*

// use -s to see what the effect would be to remove it but does not actually remove it
apt -s remove python2.7
sudo apt autoremove
sudo apt -s remove python2.7


grep bin/python$ /usr/bin/*

pip install setuptools
pip install setuptools==3.7
python --version
setuptools --version
pip install -e .
pip install -r dev-requirements.txt
pip install -e .

python -m venv ver3.7

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

Who uses Sphinx-Gallery

• Sphinx-Gallery
• Scikit-learn
• Nilearn
• MNE-python
• PyStruct
• GIMLi
• Nestle
• pyRiemann
• scikit-image
• Astropy
• SunPy
• PySurfer
• Matplotlib Examples and Tutorials
• PyTorch tutorials
• Cartopy
• PyVista
• SimPEG
• PlasmaPy
• Fury

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 dependency is:

• Sphinx >= 1.8.3

Sphinx-Gallery has also support for packages like:

• Matplotlib
• Seaborn
• Mayavi

For much of this functionality, you will need pillow. We also recommend installing system optipng binaries to reduce the file sizes of the generated PNG files.

Install as a Sphinx-Gallery developer

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 dev-requirements.txt
$ pip install -e .

Citation

If you would like to cite Sphinx-Gallery you can do so using our Zenodo deposit.