Metadata-Version: 2.5
Name: sphinx-pele
Version: 0.1.0
Summary: Pele mermaid diagrams for Sphinx
Project-URL: Repository, https://github.com/python-project-templates/sphinx-pele
Project-URL: Homepage, https://github.com/python-project-templates/sphinx-pele
Author-email: the sphinx-pele authors <t.paine154@gmail.com>
License: Apache-2.0
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.11
Requires-Dist: pyyaml>=6
Requires-Dist: sphinx>=7.4
Provides-Extra: develop
Requires-Dist: build; extra == 'develop'
Requires-Dist: bump-my-version; extra == 'develop'
Requires-Dist: check-dist; extra == 'develop'
Requires-Dist: codespell; extra == 'develop'
Requires-Dist: hatch-js; extra == 'develop'
Requires-Dist: hatchling; extra == 'develop'
Requires-Dist: mdformat; extra == 'develop'
Requires-Dist: mdformat-frontmatter; extra == 'develop'
Requires-Dist: mdformat-tables>=1; extra == 'develop'
Requires-Dist: myst-parser>=3; extra == 'develop'
Requires-Dist: pytest; extra == 'develop'
Requires-Dist: pytest-cov; extra == 'develop'
Requires-Dist: ruff; extra == 'develop'
Requires-Dist: twine; extra == 'develop'
Requires-Dist: ty; extra == 'develop'
Requires-Dist: uv; extra == 'develop'
Requires-Dist: wheel; extra == 'develop'
Description-Content-Type: text/markdown

# sphinx-pele

Pele mermaid diagrams for Sphinx

[![Build Status](https://github.com/python-project-templates/sphinx-pele/actions/workflows/build.yaml/badge.svg?branch=main&event=push)](https://github.com/python-project-templates/sphinx-pele/actions/workflows/build.yaml)
[![codecov](https://codecov.io/gh/python-project-templates/sphinx-pele/branch/main/graph/badge.svg)](https://codecov.io/gh/python-project-templates/sphinx-pele)
[![License](https://img.shields.io/github/license/python-project-templates/sphinx-pele)](https://github.com/python-project-templates/sphinx-pele)
[![PyPI](https://img.shields.io/pypi/v/sphinx-pele.svg)](https://pypi.python.org/pypi/sphinx-pele)

## 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+:

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

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

```rst
.. 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](docs/src/tutorial.md), or follow
[how to add diagrams](docs/src/usage.md) in an existing Sphinx project.

- [Styling and themes](docs/src/styling.md)
- [Migration from sphinxcontrib-mermaid](docs/src/migration.md)
- [Configuration reference](docs/src/configuration.md)
- [Diagram gallery](docs/src/examples.md) and [reStructuredText examples](docs/src/rst-examples.rst)
- [Troubleshooting](docs/src/troubleshooting.md)
- [Rendering and non-HTML output](docs/src/rendering.md)
- [Local development](docs/src/development.md)

Build the documentation with `python -m sphinx -W -b html docs docs/_build/html`.
See the [documentation homepage](docs/index.md) for the full navigation.

> [!NOTE]
> This library was generated using [copier](https://copier.readthedocs.io/en/stable/) from the [Base Python Project Template repository](https://github.com/python-project-templates/base).
