Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

Sphinx extenstion to generate diagrams and flowcharts via Mermaid.js

Project description

Sphinx extenstion to generate diagrams and flowcharts via Mermaid.js.

Feature

  • provide mermaidjs directives to generate diagrams and flowcharts for reStructuredText

Installation

Install via pip:

$ pip install sphinxcontrib.mermaidjs

setup conf.py with:

extensions = ['sphinxcontrib.mermaidjs', ]

This package is NOT includes Mermaid.js and Mermaid.css themselves. So, you need to add setup function into conf.py, as below.

def setup(app):
    app.add_javascript('path/to/mermaid.min.js')
    app.add_javascript('path/to/mermaid.min.css')

And then:

$ make html

License

Licensed under the Apache Software License . See the LICENSE file for specific terms.

Authors

Sphinx directive and packaging

Changes

0.1.0 (28 Jul, 2017)

  • first release

Project details


Release history Release notifications

Download files

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

Files for sphinxcontrib.mermaidjs, version 0.1.0
Filename, size File type Python version Upload date Hashes
Filename, size sphinxcontrib.mermaidjs-0.1.0.tar.gz (3.8 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page