Skip to main content
Ctrl+K

🖼️ Sphinx-Gallery

  • User guide
  • Advanced
  • Demo galleries
  • Contribution Guide
  • Changelog
  • GitHub
  • PyPI
  • User guide
  • Advanced
  • Demo galleries
  • Contribution Guide
  • Changelog
  • GitHub
  • PyPI

Section Navigation

  • Getting Started with Sphinx-Gallery
  • Structuring Python scripts for Sphinx-Gallery
  • Configuration
  • Who uses Sphinx-Gallery
  • Using Sphinx-Gallery

Using Sphinx-Gallery#

This section contains what you need to know to use and configure basic aspects of Sphinx-Gallery.

Getting started

Learn the basics of Sphinx-Gallery and set up your project by following a step-by-step guide.

Getting Started with Sphinx-Gallery

Write gallery pages

Learn the structure and syntax of the Python files that are the input for the gallery pages.

Structuring Python scripts for Sphinx-Gallery

Customize

Adapt Sphinx-Gallery to your needs through the configuration settings.

Configuration

Who uses Sphinx-Gallery

See how Sphinx-Gallery is used in existing projects.

List of projects using Sphinx-Gallery

previous

Sphinx-Gallery

next

Getting Started with Sphinx-Gallery

© Copyright 2014-2025, Sphinx-gallery developers.

Created using Sphinx 8.1.3.

Built with the PyData Sphinx Theme 0.16.1.