Sphinx-Gallery
0.5.0
Versions v: stable
Versions
dev
stable

Using Sphinx Gallery

  • Getting Started with Sphinx-Gallery
  • How to structure your Python scripts for Sphinx-Gallery
  • Configuration
  • Who uses Sphinx-Gallery

Advanced usage and information

  • Advanced usage
  • Frequently Asked Questions
  • Sphinx-Gallery Utilities

Example galleries

  • Gallery of Examples
  • Notebook style example

API and developer reference

  • Sphinx-Gallery API Reference
    • Sphinx Gallery
    • sphinx_gallery.gen_gallery
    • sphinx_gallery.backreferences
    • sphinx_gallery.gen_rst
    • sphinx_gallery.scrapers
    • sphinx_gallery.py_source_parser
    • sphinx_gallery.docs_resolv
    • sphinx_gallery.notebook
    • sphinx_gallery.downloads
    • sphinx_gallery.docs_resolv
    • sphinx_gallery.sorting
    • sphinx_gallery.binder
  • Change Log
  • Fork sphinx-gallery on Github
Sphinx-Gallery
  • Docs »
  • Sphinx-Gallery API Reference

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
docs_resolv Link resolver objects
sorting Sorters for Sphinx-Gallery (sub)sections
binder Binder utility functions
Next Previous

© Copyright 2014-2020, Sphinx-gallery developers

Built with Sphinx using a theme provided by Read the Docs.