Sphinx-Gallery API Reference

The complete Sphinx-Gallery project is automatically documented for every module.

Sphinx Gallery

sphinx_gallery:

gen_gallery	Sphinx-Gallery Generator
backreferences	Backreferences Generator
gen_rst	RST file generator
scrapers	Scrapers for embedding images
py_source_parser	Parser for python source files
docs_resolv	Link resolver objects
notebook	Parser for Jupyter notebooks
downloads	Utilities for downloadable items
sorting	Sorters for Sphinx-Gallery (sub)sections
binder	Binder utility functions
directives	Custom Sphinx directives

Utilities

Miscellaneous utilities.

sphinx_gallery.utils:

optipng(fname[, args])

Optimize a PNG in place.