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.


pip install sphinxcontrib-sadisplay


Add sadisplay to extensions list:

extenstion = ['sphinxcontrib.sadisp', ]

Add options to

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

Render image:

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

Render link to image (html only):

.. sadisplay::
    :module: myapp.model.user,
    :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.

Files for sphinxcontrib-sadisplay, version 0.3.3.dev20180712
Filename, size File type Python version Upload date Hashes
Filename, size sphinxcontrib_sadisplay-0.3.3.dev20180712-py3-none-any.whl (6.3 kB) File type Wheel Python version 3.6 Upload date Hashes View
Filename, size sphinxcontrib-sadisplay-0.3.3.dev20180712.tar.gz (7.8 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page