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.6.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.6-py3-none-any.whl (873.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_svgio-0.0.6.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.6.tar.gz
Algorithm Hash digest
SHA256 aed4a4ead2ae7412cc8bf7b0ce941dbd608c79c63b15f140ac2bb777e13c8c14
MD5 39d80b137d55bc4e3d83ba72d9ba1ab7
BLAKE2b-256 71d2ff095f00cb245b4beb231af79a8debf98249ba480da23fad3ed947e0dd09

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sphinx_svgio-0.0.6-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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 eb1862d348d7fcd3052644c2ab14ee5cb8c64a459c12548bbd12a4da437f572e
MD5 b95103d63bfc081a655caf6175d40143
BLAKE2b-256 14a4bcad7744ce2f2cf3c77da26a491cabe8fd5764bc3f6acba6b557c625a4d8

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