sphinxcontrib-sadisplay

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 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

This version

0.3.3.dev20180712 pre-release

Jul 12, 2018

0.3.2dev-20130518 pre-release

May 18, 2013

0.3.1dev-20120514 pre-release

May 14, 2012

0.3dev-20110719 pre-release

Jul 19, 2011

0.2dev-20110425 pre-release

Apr 25, 2011

0.1dev-20110323 pre-release

Mar 23, 2011

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 Jul 12, 2018	Hashes View hashes
Filename, size sphinxcontrib-sadisplay-0.3.3.dev20180712.tar.gz (7.8 kB)	File type Source	Python version None	Upload date Jul 12, 2018	Hashes View hashes

Hashes for sphinxcontrib_sadisplay-0.3.3.dev20180712-py3-none-any.whl
Algorithm	Hash digest
SHA256	`9a9a99fdcc2f9790bb23242f725ab999a94ae52fa6bb32ec8d2c20a83b9cc6c7`
MD5	`7225b6ec83b6e67c23ff4f3c419b854e`
BLAKE2-256	`1be750a1acbd888ea2c0e8790706b80ada440d84f74da0cf6bff5a324609111e`