Skip to main content

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

  1. python3 -m pip install sphinxcontrib-drawio
  2. In your sphinx config:
extensions = [
    "sphinxcontrib.drawio"
]
  1. 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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for sphinxcontrib-drawio, version 0.0.3
Filename, size File type Python version Upload date Hashes
Filename, size sphinxcontrib_drawio-0.0.3-py3-none-any.whl (4.7 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size sphinxcontrib-drawio-0.0.3.tar.gz (3.7 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page