Metadata-Version: 2.3
Name: sphinx-ref-in-plantuml-hyperlinks
Version: 0.7.3
Summary: sphinx-ref-in-plantuml-hyperlinks is a Sphinx extension to resolve std:ref-s defined in plantuml files
License: MIT License
         
         Copyright (c) 2024 mi-parkes
         
         Permission is hereby granted, free of charge, to any person obtaining a copy
         of this software and associated documentation files (the "Software"), to deal
         in the Software without restriction, including without limitation the rights
         to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
         copies of the Software, and to permit persons to whom the Software is
         furnished to do so, subject to the following conditions:
         
         The above copyright notice and this permission notice shall be included in all
         copies or substantial portions of the Software.
         
         THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
         IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
         FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
         AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
         SOFTWARE.
Author: Michael Parkes
Author-email: mparkes@post.cz
Requires-Python: >=3.10,<4.0
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: lxml (>=5.4.0,<6.0.0)
Requires-Dist: sphinx (>=6.1.3)
Requires-Dist: sphinx-needs (>=2.0.0)
Requires-Dist: sphinxcontrib-drawio (>=0.0.17,<0.0.18)
Description-Content-Type: text/markdown

# Enhanced integration between Sphinx documentation, PlantUML, and DrawIO diagrams

`sphinx_ref_in_plantuml_hyperlinks` is a [Sphinx](https://www.sphinx-doc.org/en/master/index.html) extension that automatically resolves references (links) created using the `std:ref:` syntax within [PlantUML](https://plantuml.com) and [DrawIO](https://pypi.org/project/sphinxcontrib-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.

![](https://mi-parkes.github.io/sphinx-ref-in-plantuml-hyperlinks/_images/refInPlantuml.png)

## 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](https://pypi.org/project/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


