sphinx-mermaid 0.0.5a0

Mermaid graph support for sphinx generated documentations

Mermaid support for Sphinx documentation

Mermaid graphs support for sphinx generated documentations.

• GitHub repository at Doreapp/sphinx-mermaid
• Pypi package sphinx-mermaid
• Example of usage: GitHub pages of this repo

Install

pip install sphinx-mermaid

Setup in conf.py

In the conf.py file of your documentation, add the extension:

extensions = [
    ...,
    'sphinxmermaid'
]

Usage

In your rst (or md) files, use the directive just like:

.. mermaid ::

    graph TD
    A --> B
    B -- Label --> C