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.
The drawio-desktop package does not run without an x-server (e.g. when in a CI
environment), see
this issue.
The workaround is to install xvfb-run
.
Installation
python3 -m pip install sphinxcontrib-drawio
- In your sphinx config:
extensions = [
"sphinxcontrib.drawio"
]
- Add the binary to
$PATH
. For Windows addC:\Program Files\draw.io
and on Linux add/opt/draw.io/
. - (required by default, see below)
sudo apt install xvfb
Options
These are the available options and their default values.
drawio_output_format = "png"
drawio_binary_path = "/path/to/draw.io-binary"
drawio_headless = True
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.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3b922e52359b2eb4a24d4cb00cd83c6a5d784d65524985818ba92dd8b96d63a1 |
|
MD5 | 8de28922aa3756eb32719217835a4b1e |
|
BLAKE2b-256 | b8474da99afcef57c875bd48422aa8cbb4e8db29e923e17c769f5e667f22d73b |
Close
Hashes for sphinxcontrib_drawio-0.0.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d8868c7f2f7581c4e759b5874b06059f2135cb297abf5c34c18791ed544e8357 |
|
MD5 | f85a233d7bb730dd6bd63a84743deca6 |
|
BLAKE2b-256 | b0074e76394d3f9329daacd5516d8ae46296d9e4bc25c2ec182da48e201e8fd3 |