Skip to main content

Sphinx "sadisplay" extension

Project description

Rendering PlantUML diagrams or GraphViz directed graphs generated from SqlALchemy models.

Most part of code based on sphinxcontrib-plantuml source code.

Install

pip install sphinxcontrib-sadisplay

Usage

Add sadisplay to extensions list:

extenstion = ['sphinxcontrib.sadisp', ]

Add options to conf.py:

plantuml = 'java -jar plantuml.jar'.split()
graphviz = 'dot -Tpng'.split()
sadisplay_default_render = 'plantuml'

Render image:

.. sadisplay::
    :module: myapp.model.user, myapp.model.post

Render link to image (html only):

.. sadisplay::
    :module: myapp.model.user, myapp.model.post
    :link:
    :alt: My Schema
    :render: graphviz

Project details


Download files

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

Source Distribution

Built Distribution

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