ppc64le/linux/: sphinx-gallery-0.19.0 metadata and description
A Sphinx extension that builds an HTML gallery of examples from any set of Python scripts.
| author_email | Óscar Nájera <[email protected]> |
| classifiers |
|
| description_content_type | text/x-rst |
| dynamic | license-file |
| license | 3-clause BSD |
| license_file | LICENSE |
| metadata_version | 2.4 |
| project_urls |
|
| provides_extras | show-memory |
| requires_dist |
|
| requires_python | >=3.8 |
| File | Tox results | History |
|---|---|---|
sphinx_gallery-0.19.0-py3-none-any.whl
|
|
A Sphinx extension that builds an HTML gallery of examples from any set of Python scripts. Check out the documentation for introductions on how to use it and more…
Quickstart
Sphinx-Gallery can be used to generate an example gallery from .py files, for a library, as well as a stand-alone web page showcasing examples of a particular Python package, module, or class.
- Let’s get started with a simple example or check out the
documentation for introductions on how to use it and more…
Install via pip
You can do a direct install via pip by using:
$ pip install sphinx-galleryAdd examples to your docs
Let’s assume simple scenario, you have a Python package with a directory structure like this:
├── doc
│ ├── conf.py
│ ├── index.rst
| ├── make.bat
│ └── Makefile
├── my_python_module
│ ├── __init__.py
│ └── mod.py
└── examples
├── plot_example.py
└── README.txt (or .rst)Enable Sphinx-Gallery by adding the following to your doc/conf.py:
extensions = [
...
'sphinx_gallery.gen_gallery',
]
# path to the examples scripts
sphinx_gallery_conf = {
'examples_dirs': '../examples', # path to your example scripts
'gallery_dirs': 'auto_examples', # path to where to save gallery generated output
}Finally just compile your docs as usual. Sphinx-Gallery will generate reST files, adding execution outputs, and save them in auto_examples/. Add a link to auto_examples/index.rst to include the gallery in your documentation.
Who uses Sphinx-Gallery
An incomplete list:
Contributing
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
$ conda install graphviz # if using conda, you can get graphviz this way
$ pip install -e .[dev]Check that you are all set by running:
$ pytest sphinx_galleryHow to cite
If you would like to cite Sphinx-Gallery you can do so using our Zenodo deposit.