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.5.dev20210512
Filename, size File type Python version Upload date Hashes
Filename, size sphinxcontrib_sadisplay-0.3.5.dev20210512-py3-none-any.whl (4.8 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size sphinxcontrib-sadisplay-0.3.5.dev20210512.tar.gz (8.4 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page