Metadata-Version: 2.4
Name: sphinx-need-svg
Version: 0.3.0
Summary: Sphinx-Needs extension for SVG diagrams with clickable need links
Project-URL: Homepage, https://github.com/cpolzer/sphinx-need-svg
Project-URL: Repository, https://github.com/cpolzer/sphinx-need-svg
Project-URL: Documentation, https://sphinx-need-svg.readthedocs.io/en/latest/
Author-email: christian polzer <coders@hai-fai.de>
License: MIT License
        
        Copyright (c) 2026 sphinx-need-svg contributors
        
        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.
License-File: LICENSE
Keywords: diagrams,sphinx,sphinx-needs,svg
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: Sphinx
Classifier: Framework :: Sphinx :: Extension
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Documentation
Requires-Python: >=3.9
Requires-Dist: sphinx-needs>=2.0
Requires-Dist: sphinx>=5.0
Provides-Extra: dev
Requires-Dist: commitizen; extra == 'dev'
Requires-Dist: detect-secrets; extra == 'dev'
Requires-Dist: furo; extra == 'dev'
Requires-Dist: mypy; extra == 'dev'
Requires-Dist: myst-parser; extra == 'dev'
Requires-Dist: pre-commit; extra == 'dev'
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: pytest-cov; extra == 'dev'
Requires-Dist: pytest-regressions; extra == 'dev'
Requires-Dist: ruff; extra == 'dev'
Requires-Dist: sphinx; extra == 'dev'
Requires-Dist: sphinx-needs; extra == 'dev'
Provides-Extra: docs
Requires-Dist: furo; extra == 'docs'
Requires-Dist: myst-parser; extra == 'docs'
Requires-Dist: sphinx; extra == 'docs'
Requires-Dist: sphinx-needs; extra == 'docs'
Provides-Extra: test
Requires-Dist: furo; extra == 'test'
Requires-Dist: myst-parser; extra == 'test'
Requires-Dist: pytest; extra == 'test'
Requires-Dist: pytest-cov; extra == 'test'
Requires-Dist: pytest-regressions; extra == 'test'
Requires-Dist: sphinx; extra == 'test'
Requires-Dist: sphinx-needs; extra == 'test'
Description-Content-Type: text/markdown

# sphinx-need-svg

A [Sphinx-Needs](https://sphinx-needs.readthedocs.io/) extension for rendering
SVG diagrams with clickable links to needs entities.

Write SVG markup with Jinja2 templating directly in your RST documentation.

## Quick Start

```bash
pip install sphinx-need-svg
```

Add to `conf.py`:

```python
extensions = ["sphinx_needs", "sphinx_need_svg"]
```

Use in RST:

```rst
.. needsvg::

   <svg width="200" height="50">
     <a href="{{ ref('REQ_001') }}">
       <text x="10" y="30">{{ needs['REQ_001'].title }}</text>
     </a>
   </svg>
```

## Development

```bash
mise install     # set up Python via mise
mise run install # install deps with uv
mise run test    # run tests
mise run docs    # build documentation
```

See the [documentation](docs/) for full details.

## AI Agent Skill

The repository includes a generated [`SKILL.md`](SKILL.md) that teaches AI
coding agents how to use this extension — directive options, Jinja helpers,
configuration, and patterns like drilldown navigation.  CI keeps it up to date
automatically.
