Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

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

Download files

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

Source Distribution

sphinxcontrib-sadisplay-0.3.2dev-20130518.tar.gz (8.3 kB view details)

Uploaded Source

File details

Details for the file sphinxcontrib-sadisplay-0.3.2dev-20130518.tar.gz.

File metadata

File hashes

Hashes for sphinxcontrib-sadisplay-0.3.2dev-20130518.tar.gz
Algorithm Hash digest
SHA256 e05e916b79b14513162742ef7ac4fa204ddc5d2b6215c6950469f127387463f7
MD5 6658b79a071d4732e2a3a481ac4679a9
BLAKE2b-256 82cd38707f2c70bab71a6fe30fe5c60fb3d235a3d8b11ca2ef39073c100f424b

See more details on using hashes here.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page