sphinx-pele

Render Mermaid diagrams in Sphinx with bundled Pele assets. HTML readers get responsive SVG and optional zoom controls; other builders retain Mermaid source.

Start with a working diagram

The tutorial takes you from an empty directory to a page with a captioned, zoomable diagram.

Tutorial

• Build your first diagram

Solve an authoring task

These guides cover existing Sphinx projects, visual customization, migration, and local checks.

How-to guides

• How to add Mermaid diagrams
• How to style diagrams
• How to migrate from sphinxcontrib-mermaid
• How to troubleshoot diagrams
• How to build and check the documentation locally

Look up options and examples

The reference records supported settings and their precedence. The example pages pair reusable source with output from the bundled renderer.

Reference

• Configuration reference
• Diagram examples
• reStructuredText examples

Understand the rendering model

Learn why diagrams render in the browser and what that means for layout, configuration, and non-HTML output.

Explanation

• Rendering and output