Skip to main content

Sphinx extension for drawio embedding

Project description

Sphinx SVG.IO Package

This is a simple extension for embedding draw.io diagramms into sphinx docs.

Usage

In conf.py:

extensions = ["sphinx_svgio"]

drawio_js_offline_path = "path/to/viewer-static.min.js" # relative to conf.py or absolute

In rst:

.. svgio:: path/to/scheme.drawio.svg
    :name: scheme_1
    :page: 2
    :caption: some caption

With page option you can choose an initial page of complex draw.io scheme. By default it is page 1

Also it is possible to add a description for every diagramm page:

.. svgio-list::
    :name: scheme_1

    .. svgio-page::
        :page: 1

        page 1 description

    .. svgio-page::
        :page: 2

        page 2 description


    .. svgio-page::
        :page: 3

        page 3 description

:name: option must be the same as in the target svgio:: directive

Project details


Download files

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

Source Distribution

sphinx_svgio-0.0.7.tar.gz (856.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sphinx_svgio-0.0.7-py3-none-any.whl (873.5 kB view details)

Uploaded Python 3

File details

Details for the file sphinx_svgio-0.0.7.tar.gz.

File metadata

  • Download URL: sphinx_svgio-0.0.7.tar.gz
  • Upload date:
  • Size: 856.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.8.20

File hashes

Hashes for sphinx_svgio-0.0.7.tar.gz
Algorithm Hash digest
SHA256 f4630e06282dbf9faad5949c8099c60e0ea2915476511c9dbf1660714e4e79a9
MD5 34e6e6d59a1f1903ccad49ae5c55948c
BLAKE2b-256 f403c7a1d2f811782724ce00ffa1adf7d9479048a1d7c71345ce2145711a13ae

See more details on using hashes here.

File details

Details for the file sphinx_svgio-0.0.7-py3-none-any.whl.

File metadata

  • Download URL: sphinx_svgio-0.0.7-py3-none-any.whl
  • Upload date:
  • Size: 873.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.8.20

File hashes

Hashes for sphinx_svgio-0.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 1303f5eba0a96a6f40fef8e84ce6a4b6a630edc871e0e258f789e9a604a939e3
MD5 213442c76b0527a6ba15c77b649e4a38
BLAKE2b-256 54a77cb3d135634fc299f1e9c057a8a9d90d78c38e5eab30569dcd93f1f0ae8a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page