Sphinx SVG.IO Package
This is a simple extension for embedding draw.io diagramms into sphinx docs.
Usage
Diagram Embedding
In conf.py:
extensions = ["sphinx_svgio"]
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 a page 1
Diagram Descriptions
It is possible to add a description for every diagram page.
Content of relevant svgio-page:: will be moved right under diagram for convenience:
.. svgio:: path/to/scheme.drawio.svg
:name: scheme_1
.. svgio-list::
:name: scheme_1
:expand:
.. svgio-page:: 1
page 1 description
.. svgio-page:: 2
page 2 description
.. svgio-page:: 3
page 3 description
:name: option must be the same as in the target svgio:: directive
Presence of :expand: option keeps all pages in a list visible.
Diagram Page references
Page of diagram can be referenced using new reference type:
:pageref:`Link title <scheme_1:2>`
1 maintainer
Metadata
1 maintainer
Release files for sphinx-svgio 0.0.9
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| sphinx_svgio-0.0.9.tar.gz | 856.9 kB | Without provenance | Details for sphinx_svgio-0.0.9.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| sphinx_svgio-0.0.9-py3-none-any.whl | Python 3 | none | any | Details for sphinx_svgio-0.0.9-py3-none-any.whl |
Total release size: 1.7 MB
Release files / sphinx_svgio-0.0.9.tar.gz
| Download URL | sphinx_svgio-0.0.9.tar.gz |
|---|---|
| Size | 856.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4312bcb33d558b852ca6d344ceb660a1bd6d3c6e1cf50c015ad9d54a6ad2243b
|
|
BLAKE2b-256 checksum How to use checksums |
84ce216065253ebb13954bc69c51d011981abb159abb6dce6761f586fcab29b2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.8.20
|
Release files / sphinx_svgio-0.0.9-py3-none-any.whl
| Download URL | sphinx_svgio-0.0.9-py3-none-any.whl |
|---|---|
| Size | 874.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
fa097f0cb9608a2729fca14b69b33ccbbf95f9de7fc5a24548b8f08e2704535e
|
|
BLAKE2b-256 checksum How to use checksums |
63e546edf00d44d02d5c810ef1cb258eac38ba12b4dc814263e875405dd391bb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.8.20
|
Security for sphinx-svgio 0.0.9
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
