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 Mkdocs-Gallery.

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

Matplotlib animation support

Example with the plotly graphing library

Example with the mayavi graphing library

Example with the pyvista 3d plotting library

Support for asynchronous code

No image output examples

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

A short Python script

Example that fails to execute

Constrained Text output frame

SyntaxError

Download all examples in Python source code: gallery_python.zip

Download all examples in Jupyter notebooks: gallery_jupyter.zip

Gallery generated by mkdocs-gallery