Features

Features#

ID

Title

Status

Refinement

ftr_demo_00001

Connect Sphinx References in SVGs

open

ftr_demo_00002; ftr_demo_00003

ftr_demo_00002

Support Standard Sphinx References

open

ftr_demo_00003

Support Sphinx-Needs References

open

ftr_demo_00004

ftr_demo_00004

Configurable Verbose Logging

open

ftr_demo_00005

Handle Unresolved References Gracefully

open

@startuml ' Nodes definition node "<size:12>Feature</size>\n**Connect Sphinx**\n**References in**\n**SVGs**\n<size:10>ftr_demo_00001</size>" as ftr_demo_00001 [[../traceability/features.html#ftr_demo_00001]] #LightGreen node "<size:12>Feature</size>\n**Support**\n**Standard Sphinx**\n**References**\n<size:10>ftr_demo_00002</size>" as ftr_demo_00002 [[../traceability/features.html#ftr_demo_00002]] #LightGreen node "<size:12>Feature</size>\n**Support Sphinx-**\n**Needs**\n**References**\n<size:10>ftr_demo_00003</size>" as ftr_demo_00003 [[../traceability/features.html#ftr_demo_00003]] #LightGreen node "<size:12>Feature</size>\n**Configurable**\n**Verbose Logging**\n<size:10>ftr_demo_00004</size>" as ftr_demo_00004 [[../traceability/features.html#ftr_demo_00004]] #LightGreen node "<size:12>Feature</size>\n**Handle**\n**Unresolved**\n**References**\n**Gracefully**\n<size:10>ftr_demo_00005</size>" as ftr_demo_00005 [[../traceability/features.html#ftr_demo_00005]] #LightGreen ' Connection definition ftr_demo_00001 --> ftr_demo_00002 ftr_demo_00001 --> ftr_demo_00003 ftr_demo_00003 --> ftr_demo_00004 @enduml

Feature: Connect Sphinx References in SVGs ftr_demo_00001
status: open
refines: ftr_demo_00002, ftr_demo_00003
satisfied by: req_demo_00001, req_demo_00004, req_demo_00005, req_demo_00006, req_demo_00007, req_demo_00008

This feature enables Sphinx documentation to automatically resolve and update cross-references (e.g., :ref:, :doc:) and Sphinx-Needs references within SVG diagrams. This allows users to create interactive, clickable diagrams that link directly to other parts of their documentation.
Feature: Support Standard Sphinx References ftr_demo_00002
status: open
refined by: ftr_demo_00001
satisfied by: req_demo_00002
realized by: usc_demo_00001

The system shall identify and resolve standard Sphinx cross-references (:ref:, :doc:) found within xlink:href attributes of SVG elements. Resolved references will be replaced with their absolute or relative URIs.
Feature: Support Sphinx-Needs References ftr_demo_00003
status: open
refines: ftr_demo_00004
refined by: ftr_demo_00001
satisfied by: req_demo_00003
realized by: usc_demo_00002

The system shall identify and resolve Sphinx-Needs references (:need:) found within xlink:href attributes of SVG elements, provided the needs_build_json configuration is enabled.
Feature: Configurable Verbose Logging ftr_demo_00004
status: open
refined by: ftr_demo_00003
satisfied by: req_demo_00009, req_demo_00010
realized by: usc_demo_00003

The extension shall provide a configuration option (sphinx_diagram_connect_verbose) to enable or disable verbose logging of reference resolution operations during the Sphinx build process. This helps in debugging and understanding the extension’s behavior.
Feature: Handle Unresolved References Gracefully ftr_demo_00005
status: open
satisfied by: req_demo_00009

The extension shall log a warning for any Sphinx or Sphinx-Needs references within SVG files that could not be resolved to a valid URI, without halting the build process.