Welcome to Sphinx-Gallery’s documentation!

A Sphinx extension that builds an HTML gallery of examples from any set of Python scripts.

It is extracted from the scikit-learn project and aims to be an independent general purpose extension.

The code of the project is on Github: Sphinx-Gallery

Why Sphinx-Gallery?

• Simple examples that run out of the box are the best way to learn a library
• Pleasing, organized, visual layouts
• Links, searching, backlinks throughout examples and documentation

What does it look like?

Here is an example gallery generated from a few Python scripts.

Examples using numpy.sin

Seaborn example

Identifying function names in a script

Plotting simple sin function

Plotting simple sin function on a black background

Here we put only the examples of our gallery that refer to a specific function. This provides display granularity that can be used within your documentation in addition to large galleries with all examples together.

Go ahead, click on those thumbnails to go to the examples. Beautifully rendered HTML versions of the original python scripts with, narrating prose from the doctrings and inline comments and plots generated by the scripts.

Features

• Runs Python files and captures outputs + figures. Learn how to Set up your project
• Managing multiple galleries no number limit.
• Automatically hyperlink the code in the gallery to the corresponding function documentation. Linking to documentation
• Automatically links from documented functions to examples using the function. Adding references to examples
• Notebook styled examples: turn your scripts into a full narrative with the Notebook Styled examples syntax

Sphinx-Gallery Show: Gallery of Examples

Contents:

• Getting Started with Sphinx-Gallery
  • Who uses Sphinx-Gallery
  • Getting the package
  • Set up your project
  • Know your Gallery files
• Configuration
  • List of config options
  • Managing multiple galleries
  • Parsing and executing examples based on matching patterns
  • Sorting gallery subsections
  • Sorting gallery examples
  • Linking to documentation
  • Adding references to examples
  • Using a custom default thumbnail
  • Adding line numbers to examples
  • Disabling download button of all scripts
  • Choosing the thumbnail image
  • Generate Binder links for gallery notebooks (experimental)
  • Building without executing examples
  • Image scrapers
  • Resetting modules
  • Dealing with failing Gallery example scripts
  • Setting gallery thumbnail size
  • Minimal reported time
• Frequently Asked Questions
  • Why is __file__ not defined? What can I use?
• Sphinx-Gallery Syntax
  • Simple examples
  • Notebook Styled examples syntax
• Sphinx-Gallery Utilities
  • Convert Python scripts into Jupyter Notebooks
  • Embedding Sphinx-Gallery inside your documentation script extensions
• 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
• Gallery of Examples
  • General examples
  • The sin function
  • Examples which don’t produce image output
• Secondary gallery
  • Notebook styled examples
  • Seaborn notebooks
• Change Log
  • git master
  • v0.2.0
  • v0.1.13
  • v0.1.12
  • v0.1.11
  • v0.1.10
  • v0.1.9
  • v0.1.8
  • v0.1.7
  • v0.1.6
  • v0.1.5
  • v0.1.4
  • v0.1.3
  • v0.1.2
  • v0.1.1
  • v0.1.0
  • v0.0.11
  • v0.0.10
• Fork sphinx-gallery on Github

Indices and tables

• Index
• Module Index
• Search Page