Skip to main content

Enhanced integration between Sphinx documentation, PlantUML, and DrawIO diagrams

sphinx_ref_in_plantuml_hyperlinks is a Sphinx extension that automatically resolves references (links) created using the std:ref: syntax within PlantUML and DrawIO diagrams. This allows you to link elements in your diagrams to corresponding sections or elements in your Sphinx documentation, enhancing navigation and information flow.

Example of Use

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

    @startmindmap mindmap2

    *[#Orange] Example of clickable references
    **[#lightgreen] [[ ":ref:`plantuml label1`" Internal Page Reference1 ]]
    **[#lightblue] [[ ":ref:`N_00001`" Internal Page Reference2 on Sphinx-Needs ]]

    @endmindmap

Installation

You can install sphinx-ref-in-plantuml-hyperlinks with pip

pip install sphinx-ref-in-plantuml-hyperlinks

Alternatively (Linux)

git clone https://github.com/mi-parkes/sphinx-ref-in-plantuml-hyperlinks.git
cd sphinx-ref-in-plantuml-hyperlinks

poetry install
poetry build

pip install dist/sphinx_ref_in_plantuml_hyperlinks*.whl

Activation

In your conf.py configuration file, add sphinx_ref_in_plantuml_hyperlinks to your extensions list:

extensions = [
  ...
  'sphinx_ref_in_plantuml_hyperlinks'
  ...
]

List Labels:

poetry run task labels

Metadata

Release files for sphinx-ref-in-plantuml-hyperlinks 0.7.3

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-ref-in-plantuml-hyperlinks 0.7.3
File Size Uploaded Provenance Actions
sphinx_ref_in_plantuml_hyperlinks-0.7.3.tar.gz 4.1 kB Without provenance Details for sphinx_ref_in_plantuml_hyperlinks-0.7.3.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for sphinx-ref-in-plantuml-hyperlinks 0.7.3
File Interpreter ABI Platform Actions
sphinx_ref_in_plantuml_hyperlinks-0.7.3-py3-none-any.whl Python 3 none any Details for sphinx_ref_in_plantuml_hyperlinks-0.7.3-py3-none-any.whl

Total release size: 9.2 kB

Security for sphinx-ref-in-plantuml-hyperlinks 0.7.3

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.

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