A Sphinx extension that builds an HTML version of any Python script and puts it into an examples gallery.
Project description
A Sphinx extension that builds an HTML version of any Python script and puts it into an examples gallery.
Who uses Sphinx-Gallery
Installation
Install via pip
You can do a direct install via pip by using:
$ pip install sphinx-gallerySphinx-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.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file sphinx-gallery-0.11.1.tar.gz.
File metadata
- Download URL: sphinx-gallery-0.11.1.tar.gz
- Upload date:
- Size: 393.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.10.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 56ccb29a0c2c4767d2a66617ba6ea7893e3a3885b6d972c62783a3b45b583ea5 |
|
| MD5 | 34038a82a8dafd1f43dabc0a0968e210 |
|
| BLAKE2b-256 | a8fcafffbf7d5ae709f0f18d1ce06a1b2a300b72bac13248194e1a51af247c62 |
File details
Details for the file sphinx_gallery-0.11.1-py3-none-any.whl.
File metadata
- Download URL: sphinx_gallery-0.11.1-py3-none-any.whl
- Upload date:
- Size: 138.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.10.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | b165cb366a5768a0f36e60e5bc6828fbf55fd1831e71645310167375223aa25c |
|
| MD5 | 3100779270a9ca29e54cf607d8f2c2d5 |
|
| BLAKE2b-256 | 05f25ddc3048dae2e0cc825adfd353f6f47d3cec0801e5a841322c4448167c21 |
