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.