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
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.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 |
Close
Hashes for sphinxcontrib_sadisplay-0.3.5.dev20210512-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 0f61e95f226349aff6b72d7c9faf2690107867adcc150f741856797e4bccae66 |
|
| MD5 | 668364fda4f5052b33c9bb3f167f5a41 |
|
| BLAKE2-256 | 6bc0759455322ece0f497876e6b75687ac89ba972987c74e96b77dfe461ec991 |
Close
Hashes for sphinxcontrib-sadisplay-0.3.5.dev20210512.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | be45652e02cc7dbe39ffa37f4b078ab231ab30b5bf246869f8cb75a3313a7a45 |
|
| MD5 | f6d04e670cc4061d56aca3a4915b95fb |
|
| BLAKE2-256 | effe139a096e83fa8bc605f0addf97dfdb96030d9d6988023adcb987a330bdc7 |