Sphinx-Gallery API Reference#

Note

Sphinx-Gallery is typically used indirectly via Sphinx execution andconfiguration variables, seeConfiguration for how to do this.However, as a standard Python project, we document many functions andclasses as well below, even though these will typically not be neededby end users.

Sphinx Gallery#

sphinx_gallery:

gen_gallery

Sphinx-Gallery Generator.

backreferences

Backreferences Generator.

gen_rst

reST file generator.

scrapers

Scrapers for embedding images.

py_source_parser

Parser for python source files.

block_parser

BlockParser divides non.py source files into blocks of code and markup text.

docs_resolv

Link resolver objects.

notebook

Parser for Jupyter notebooks.

downloads

Utilities for downloadable items.

sorting

Sorters for Sphinx-Gallery (sub)sections.

interactive_example

Binder and Jupyterlite utility functions.

directives

Custom Sphinx directives.

Utilities.

Miscellaneous utilities.

sphinx_gallery.utils:

optipng(fname[, args])

Optimize a PNG in place.

On this page