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.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ff73fcaf14f9024509e13dfad9c236385d6fca8b0fb25a8919f4f4a9d5aa6ba2 |
|
MD5 | 274fed043cc69c7c18cf6b5cf0eb5b55 |
|
BLAKE2b-256 | 6f6d24029f7650ca0e07fc4f5181a0536956dc745dfc338c65b05ab67278c98f |
Close
Hashes for sphinxcontrib_drawio-0.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c2f05aa46d313ec71c90d06d563ac02ec332edbcd0a664a27323c7cc6e5c3a11 |
|
MD5 | 41fc6d382b339cb85a1d873dec967cea |
|
BLAKE2b-256 | 7aa881400db32e5fe3a8a4e930ad3cce774876db36b451b5a60581f28b59ef51 |