Skip to main content

Enhance Your Sphinx Documentation with Dynamic Diagram Links

See the complete documentation rendered with Sphinx 📚.

Unlock Seamless Navigation Between Diagrams and Documentation

sphinx_diagram_connect is a powerful Sphinx extension designed to create intelligent, clickable links within your PlantUML or DrawIO diagrams.

  • By automatically resolving std:doc or std:ref syntax, this extension allows you to effortlessly connect elements in your diagrams directly to relevant sections or components within your Sphinx documentation.

  • Also references to other domain like py:func will be resolved.

  • Optionally, references toneed items can be resolved if the sphinx-needs package is available in the Python environment and the extension is enabled in the documentation project’s conf.py.

The sphinx_diagram_connect extension works on the generated svg files of your graphical tools. This means also other diagram types are supported automatically.

This means enhanced navigation, improved information flow, and a more interactive experience for your readers!

See It in Action: Dynamic References in PlantUML

Imagine clicking on a diagram element and being taken directly to its detailed explanation in your documentation. This is precisely what sphinx_diagram_connect enables.

This example demonstrates how references of the standard domain std with :doc: and :ref: syntax within your PlantUML code becomes a live hyperlink in your rendered documentation:

.. uml::
    :caption: PlantUML Caption with **bold** and *italic*
    :name: PlantUML Label2

    @startmindmap mindmap2

    *[#Orange] Example of clickable references
    **[#lightgreen] [[ ":ref:`Heading 2`" Internal Page Arbitrary Reference1 ]]
    **[#lightblue] [[ ":ref:`N_00002`" Internal Page Arbitrary Reference2 on sphinx-needs ]]
    **[#lightgrey] [[ ":doc:`Test PlantUML 3`" Internal Page Reference3 ]]

    @endmindmap

Installation

You can easily install sphinx-diagram-connect using pip:

pip install sphinx-diagram-connect

Alternatively (for Linux users with Poetry):

git clone https://github.com/mi-parkes/sphinx-diagram-connect.git
cd sphinx-diagram-connect

poetry install
poetry build

poetry add -G sphinx dist/sphinx_diagram_connect-*-py3-none-any.whl

Activation

Once installed, simply add sphinx_diagram_connect to your extensions list in your conf.py file:

extensions = [
    ...,
    'sphinx_diagram_connect'
]

Listing Available Labels:

To see all referenceable labels in your project, use:

poetry run task labels

Metadata

Release files for sphinx-diagram-connect 1.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sphinx-diagram-connect 1.1.0
File Size Uploaded Provenance Actions
sphinx_diagram_connect-1.1.0.tar.gz 7.1 kB Without provenance Details for sphinx_diagram_connect-1.1.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for sphinx-diagram-connect 1.1.0
File Interpreter ABI Platform Actions
sphinx_diagram_connect-1.1.0-py3-none-any.whl Python 3 none any Details for sphinx_diagram_connect-1.1.0-py3-none-any.whl

Total release size: 15.0 kB

Release files / sphinx_diagram_connect-1.1.0.tar.gz

Download URL sphinx_diagram_connect-1.1.0.tar.gz
Size 7.1 kB
Tags Source
SHA-256 checksum
How to use checksums
17ae4990d460fea67a867fac430e735ce9f060f9e0c36e1b04ee5bf0586a5647
BLAKE2b-256 checksum
How to use checksums
01a13c2f79ac0056eadc524297b0254344b75eef534a7f1f1c25cf958eb866d6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.14

Release files / sphinx_diagram_connect-1.1.0-py3-none-any.whl

Download URL sphinx_diagram_connect-1.1.0-py3-none-any.whl
Size 7.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
52c58fbe05dcbd1a531e1fe82c7ccf3c4fc066527bb6034f46403fa53801803c
BLAKE2b-256 checksum
How to use checksums
febe689ebab347e8451b4978350c53e30d83cc656ecbb028772f58b6cc170d9f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.14

Security for sphinx-diagram-connect 1.1.0

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.

Release history Release notifications | RSS feed

This release

1.1.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page