sphinx-need-svg
A Sphinx-Needs extension for rendering SVG diagrams with clickable links to needs entities.
Write SVG markup with Jinja2 templating directly in your RST documentation.
Quick Start
pip install sphinx-need-svg
Add to conf.py:
extensions = ["sphinx_needs", "sphinx_need_svg"]
Use in 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
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 for full details.
AI Agent Skill
The repository includes a generated 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.
1 maintainer
Metadata
1 maintainer
Release files for sphinx-need-svg 0.3.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinx_need_svg-0.3.1.tar.gz | 191.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinx_need_svg-0.3.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 200.5 kB
Release files / sphinx_need_svg-0.3.1.tar.gz
| Download URL | sphinx_need_svg-0.3.1.tar.gz |
|---|---|
| Size | 191.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e09a16a2f38a014213facf86a5bd92547174eb72258c524b2e0710535b51033c
|
|
BLAKE2b-256 checksum How to use checksums |
c3ef718c2ea29a129a57e028e9db1b9f809b24cb647e6d18b1ba6eecad4e90d3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on May 21, 2026.
Transparency logRelease files / sphinx_need_svg-0.3.1-py3-none-any.whl
| Download URL | sphinx_need_svg-0.3.1-py3-none-any.whl |
|---|---|
| Size | 9.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
310a1aafcf0e0e72e80d713d11b76f45406a5448abe786cc025bd6119c9f056e
|
|
BLAKE2b-256 checksum How to use checksums |
a85962dd8f835265cb028a94c72248f06da6aa65b33eb33205ef4ac1a61df664
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on May 21, 2026.
Transparency log
