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.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file sphinxcontrib-sadisplay-0.3.4.dev20210416.tar.gz.
File metadata
- Download URL: sphinxcontrib-sadisplay-0.3.4.dev20210416.tar.gz
- Upload date:
- Size: 8.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/3.7.2 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0e4df3fb54257ef6caf5175a60701179f13992682451a6d991145da3f6fd19bf
|
|
| MD5 |
e900db0be15dc44f14e2d3e700451c0b
|
|
| BLAKE2b-256 |
4865e2934e7fd96fbfdc1fb6ccea9d8a6a7d0554686ae6b4a75605317a46f08d
|
File details
Details for the file sphinxcontrib_sadisplay-0.3.4.dev20210416-py3-none-any.whl.
File metadata
- Download URL: sphinxcontrib_sadisplay-0.3.4.dev20210416-py3-none-any.whl
- Upload date:
- Size: 4.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/3.7.2 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c0231354ee384f62220a3044bfab9118e6a575b6ed665e7747166011443d0ae2
|
|
| MD5 |
2d4474bad6beed26f37c620c40cbc10f
|
|
| BLAKE2b-256 |
0da269a92b9833e7f1c81f99254d0ce6c9e2e92d1bb04a159f9c8ef52cd5113b
|
