Sphinx Extension to include draw.io files
Project description
sphinxcontrib-drawio
Sphinx Extension to add the drawio
directive to include draw.io diagrams.
Important: This extension is in development and not all features will work as advertised or at all.
Installation
python3 -m pip install sphinxcontrib-drawio
- In your sphinx config:
extensions = [
"sphinxcontrib.drawio"
]
- Add the binary to $PATH. For Windows add
C:\Program Files\draw.io
and on Linux add/opt/draw.io/
.
Options
Both of these are optional.
drawio_output_format = "png"
drawio_binary_path = "/path/to/draw.io-binary"
Usage
.. drawio:: example.drawio
:format: png
:alt: An Example
:align: center
If any other of the draw.io
CLI tool's options are wanted, please file an issue.
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.
Source Distribution
Built Distribution
Close
Hashes for sphinxcontrib-drawio-0.0.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c00dbcb2ec2236b81b09c339d2462417c3c922e187cfb27db764f5101cd4479a |
|
MD5 | 4d86054a1db6bb3c25c739b2dc2d6776 |
|
BLAKE2b-256 | b0477ec6e0387ae4d8798d0719f0ab573271800b22fae8b20761354ffecf4c1e |
Close
Hashes for sphinxcontrib_drawio-0.0.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 89d1943a0b5eb686207b40d2f27f9a7dce72ff281682a38b577ca6ecce5bf9a9 |
|
MD5 | 8692e6eab9de83a85075add959d1033f |
|
BLAKE2b-256 | 74a7669548cc23fc9028bb7535588fb9446f2dc182cfa8ebee43d16baaeb5bc1 |