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
drawio_default_image_format = "png"
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
File details
Details for the file sphinxcontrib-drawio-0.0.2.1.tar.gz
.
File metadata
- Download URL: sphinxcontrib-drawio-0.0.2.1.tar.gz
- Upload date:
- Size: 3.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/44.0.0 requests-toolbelt/0.9.1 tqdm/4.28.1 CPython/3.8.1
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
a668fedc380c41843d566ac28f101b230b377c6b53e1fd0d1d788cb45e62fcff
|
|
MD5 |
47753e68716b054b4bfebd64d86f2807
|
|
BLAKE2b-256 |
84fcaf95d7e76a90c0872deb69b3a24ea1111954b92f28a1fcac28b54e44ae75
|
File details
Details for the file sphinxcontrib_drawio-0.0.2.1-py3-none-any.whl
.
File metadata
- Download URL: sphinxcontrib_drawio-0.0.2.1-py3-none-any.whl
- Upload date:
- Size: 4.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/44.0.0 requests-toolbelt/0.9.1 tqdm/4.28.1 CPython/3.8.1
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
141907f708880f26cb548d7bd8e182801775405849ea255d694c44831b783694
|
|
MD5 |
6ce6a9f37b716ded055e2d3c3dfa8ba7
|
|
BLAKE2b-256 |
8601758f50437e52958a56f75bb56fe4af9ff649d96b54097c73aa248129d148
|