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.1dev-20120514.tar.gz (9.3 kB view details)

Uploaded Source

File details

Details for the file sphinxcontrib-sadisplay-0.3.1dev-20120514.tar.gz.

File metadata

File hashes

Hashes for sphinxcontrib-sadisplay-0.3.1dev-20120514.tar.gz
Algorithm Hash digest
SHA256 941578556c8bb1fdd20b57f692603a175460aacadb2923c430ea11a45c7a83f6
MD5 90fcf6db76e43aa1979b7dbd395bb038
BLAKE2b-256 b36c8d8d256111693beae95e7d4eea06fcbc49e05d4cb99337e86b2feb1cf37d

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