Skip to content

ItayZiv/sphinxcontrib-drawio

 
 

Repository files navigation

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 and set the drawio_headless config to True.

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/.
  2. (required for drawio_headless) sudo apt install xvfb

Options

These are the available options and their default values.

drawio_output_format = "png" # from ["png", "jpg", "svg"]
drawio_binary_path = "/path/to/draw.io-binary"
drawio_headless = False

Usage

.. drawio:: example.drawio
    :format: png
    :alt: An Example
    :align: center
    :page-index: 0

If any other of the draw.io CLI tool's options are wanted, please file an issue.

About

Sphinx extension for including draw.io files.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 99.2%
  • CSS 0.8%