Repository navigation
Releases
Releases · christopheseyler/sphinx-needs-explorer
Sphinx-Needs Explorer 0.5.0
Links graph
Traceability graph of the upstream and downstream links of a need:
- Needs the selected need links to (e.g. higher level specifications) are shown above, needs linking to it (e.g. implementations and tests) below.
- Adjustable
maxDistance(1 to 10) and zoom (buttons or Ctrl+wheel). - Click a need to open it in the editor, or center the graph on it.
- Available from the graph icon of a need in the Explorer and Current views, and from the editor context menu (Sphinx-Needs: Show Links Graph of Need at Cursor).
Install
code --install-extension sphinx-needs-explorer-0.5.0.vsix
If the original useblocks.sphinx-needs-vscode extension is installed, uninstall it first.
v0.3.7
Features
- Needs filter in the Sphinx-Needs Current view header:
- switch between the needs of the current document and all needs of the
needs.json - filter by need types (
sss,srs, ...), multi selection with counts - filter by tags (needs must have all selected tags)
- clear all filters
- switch between the needs of the current document and all needs of the
- Active filters are summarized next to the view title and shown with a filled filter icon.
Install
Download sphinx-needs-vscode-0.3.7.vsix, then:
code --install-extension sphinx-needs-vscode-0.3.7.vsix --force
See v0.3.6 for the previous fixes and features of this fork.
v0.3.6
Custom build of the archived useblocks/sphinx-needs-vscode extension, with fixes for Windows and recent Sphinx-Needs versions.
Fixes
- Windows paths:
needs.jsonandsrcDirwere never found on Windows (file:///c%3A/...URIs were turned into invalid paths). Goto Definition / Find References now return proper file URIs. - Hover with recent Sphinx-Needs: the need text is read from
contentwhendescriptionis missing (hover showedundefined). - Included files: Goto Definition, Find References and the explorer locate action follow
.. include::directives to jump to the file which actually defines the need. - Exact need ID matching (
REQ_1no longer matchesREQ_10).
Features
- Locate / Copy ID actions in the Sphinx-Needs Current view.
- Refresh button in the Explorer and Current views.
- The views update when the language mode of the active document changes; included files (e.g.
*.incset to reStructuredText) show the needs defined in them. - Need items are split into Fields, Links Outgoing and Links Incoming sections; clicking a link jumps to the linked need. The
explorerOptionsdefault is nowstatus,type,tags.
Install
Download sphinx-needs-vscode-0.3.6.vsix, then:
code --install-extension sphinx-needs-vscode-0.3.6.vsix --force
It replaces the Marketplace extension useblocks.sphinx-needs-vscode (same extension ID).