Sphinx-Gallery
0.7.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
    • General examples
      • Local module
      • Introductory example - Plotting sin
      • Plotting the exponential function
      • Seaborn example
      • Capturing output representations
      • Choosing the thumbnail figure
      • Providing a figure for the thumbnail image
      • Using Unicode everywhere 🤗
      • Identifying function names in a script
      • Using sys.argv in examples
    • No image output examples
      • A short Python script
      • Example that fails to execute
      • Constrained Text output frame
      • SyntaxError
  • Notebook style example

API and developer reference

  • Sphinx-Gallery API Reference
  • Change Log
  • Fork sphinx-gallery on Github
Sphinx-Gallery
  • Docs »
  • Gallery of Examples

Gallery of Examples¶

This page consists of the ‘General example’ gallery and a sub-gallery, ‘No image output examples’. This sub-gallery is generated from a sub-directory within the general examples directory. The file structure of this gallery looks like this:

examples/           # base 'Gallery of Examples' directory
├── README.txt
├── <.py files>
└── no_output/      # generates the 'No image output examples' sub-gallery
    ├── README.txt
    └── <.py files>

General examples¶

This gallery consists of introductory examples and examples demonstrating specific features of Sphinx-Gallery.

Local module

Local module¶

Introductory example - Plotting sin

Introductory example - Plotting sin¶

Plotting the exponential function

Plotting the exponential function¶

Seaborn example

Seaborn example¶

Capturing output representations

Capturing output representations¶

Choosing the thumbnail figure

Choosing the thumbnail figure¶

Providing a figure for the thumbnail image

Providing a figure for the thumbnail image¶

Using Unicode everywhere 🤗

Using Unicode everywhere 🤗¶

Identifying function names in a script

Identifying function names in a script¶

Using ``sys.argv`` in examples

Using sys.argv in examples¶

No image output examples¶

This section gathers examples which don’t produce any figures. Some examples only output to standard output, others demonstrate how Sphinx-Gallery handles examples with errors.

A short Python script

A short Python script¶

Example that fails to execute

Example that fails to execute¶

Constrained Text output frame

Constrained Text output frame¶

SyntaxError

SyntaxError¶

Download all examples in Python source code: auto_examples_python.zip

Download all examples in Jupyter notebooks: auto_examples_jupyter.zip

Gallery generated by Sphinx-Gallery

Next Previous

© Copyright 2014-2020, Sphinx-gallery developers

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