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.
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
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 |
Close
Hashes for sphinxcontrib_sadisplay-0.3.3.dev20180712-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9a9a99fdcc2f9790bb23242f725ab999a94ae52fa6bb32ec8d2c20a83b9cc6c7 |
|
MD5 | 7225b6ec83b6e67c23ff4f3c419b854e |
|
BLAKE2-256 | 1be750a1acbd888ea2c0e8790706b80ada440d84f74da0cf6bff5a324609111e |
Close
Hashes for sphinxcontrib-sadisplay-0.3.3.dev20180712.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ccb56153a8d9fbc170f6eb69a493125914423557098034ab14a497fc26490026 |
|
MD5 | 7e8c8af6eacfa6245efe1080600ddb87 |
|
BLAKE2-256 | 68655fce905f335d20c6fbc42f296251e72c8a631cd523f67e716a4648e86db7 |