Skip to main content

Mermaid graph support for sphinx generated documentations

Project description

Mermaid support for Sphinx documentation

Mermaid graph support for sphinx generated documentations

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 : label
    B --> C

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

sphinx_mermaid-0.0.2-py2.py3-none-any.whl (3.5 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file sphinx_mermaid-0.0.2-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for sphinx_mermaid-0.0.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 834c098224227ad31336fb2140884c20e12cd08f70209bc85f72ba830e9c9cec
MD5 3cfebbf71c8ee1df7075d1cb72522eef
BLAKE2b-256 b677db43497887171cac2cf7006b36cd0e4fa826875d6a6381ce0e196a7f5346

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page