MyST Sphinx Gallery

Introduction

MyST Sphinx Gallery is a Sphinx extension that allows you to build galleries from jupyter notebooks (.ipynb), markdown (.md) or reStructuredText (.rst) files.

This extension is functionally similar to the Sphinx-Gallery extension, but aim to provide a simple and efficient way to create galleries written in a variety of formats.

Highlight Features

• Easy to use - It provides a set of directives to generate galleries, as simple as adding toctree.

• Flexible - You can easily generate a gallery of examples from your Jupyter Notebooks, Markdown, or reStructuredText files. It works with MyST ecosystem, including MyST-parser and MyST-NB, to render markdown or jupyter notebooks in Sphinx documentation.

• Fast and robust - It utilizes existing images to generate gallery thumbnails, eliminating code execution delays and potential accidental errors when building gallery.

• Customizable - You can customize the gallery, such as thumbnail selection, and style of the gallery.

Navigation

Quick Start

Learn how to install and use MyST Sphinx Gallery to generate galleries, and customize it.

To the Quick Start

Gallery Example

Explore the Demo Gallery, showcasing gallery directives, thumbnail selection strategies, and options effects.

To the Gallery Example

API Reference

Detailed API documentation for MyST Sphinx Gallery.

To the API Reference

Developer Guide

Do you want to contribute to MyST Sphinx Gallery? Check out the contributing guide.

To the Contributing Guide