myst-sphinx-gallery 0.1.1

A Sphinx extension that builds galleries of examples from any set of myst-style markdown/notebook or rst files.

MyST Sphinx Gallery is a Sphinx extension that builds a Sphinx Gallery from MyST Markdown/Notebook or RST files.

Documentation

The detailed documentation is available at: https://myst-sphinx-gallery.readthedocs.io/en/latest/

Quick Start

Tip

The quick start guide in README is a brief introduction to the MyST Sphinx Gallery extension. The full documentation of Quick Start is available at: Quick Start.

Installation

MyST Sphinx Gallery is a Python package, and requires Python >= 3.8. You can install the latest release using pip from the PyPI:

pip install myst_sphinx_gallery

Configure and usages

To use MyST Sphinx Gallery, you need to add the following code to the Sphinx conf.py file:

from pathlib import Path

from myst_sphinx_gallery import GalleryConfig, generate_gallery

myst_sphinx_gallery_config = GalleryConfig(
    examples_dirs="../../examples",
    gallery_dirs="auto_examples",
    root_dir=Path(__file__).parent,
    notebook_thumbnail_strategy="code",
)
generate_gallery(myst_sphinx_gallery_config)

Tip

You can generate multiple galleries by proper configuration in the conf.py file. For more details, please refer to the Multiple Galleries.

Construct the examples folder

To generate the gallery, you need to create a well-structured examples folder. The detailed documentation of structuring files for gallery is available at: Structuring files for Gallery.