sphinx-pele

Pele mermaid diagrams for Sphinx

Usage

Install the development version from the repository, then enable the extension. Building from source requires Git, Node.js 22+, and pnpm 11.11.0 in addition to Python 3.11+:

python -m pip install "sphinx-pele @ git+https://github.com/python-project-templates/sphinx-pele.git@main"

# conf.py
extensions = ["sphinx_pele"]
pele_options = {"zoom": "auto"}

.. mermaid::

   flowchart LR
       Mermaid --> Pele --> SVG

MyST Markdown mermaid fences and external .mmd files also work. Replace sphinxcontrib.mermaid in extensions when migrating.

Documentation

Start with the first-diagram tutorial, or follow how to add diagrams in an existing Sphinx project.

• Styling and themes
• Migration from sphinxcontrib-mermaid
• Configuration reference
• Diagram gallery and reStructuredText examples
• Troubleshooting
• Rendering and non-HTML output
• Local development

Build the documentation with python -m sphinx -W -b html docs docs/_build/html. See the documentation homepage for the full navigation.

Note

This library was generated using copier from the Base Python Project Template repository.