X

About this Software

Name Version License Github PyPi
sphinx_needs_data_explorer 0.9.3 MIT sphinx-needs-data-explorer sphinx-needs-data-explorer


Acknowledgments

This Software utilizes the following copyrighted material, the use of which is hereby acknowledged.

Name Version License Github
sphinx-needs 2.0.0 MIT https://github.com/useblocks/sphinx-needs
pegjs 0.10.0 MIT https://github.com/pegjs/pegjs
vis-network 9.1.9 MIT https://github.com/visjs/vis-network
select2 4.1.0-rc.0 MIT https://github.com/select2/select2
jQuery 3.7.1 MIT https://github.com/jquery/jquery
DataTables 1.10.16 MIT https://github.com/DataTables/DataTablesSrc


Help Information

Keyboard shortcuts

F1 Help
 
↑ Move network up
↓ Move network down
← Move network left
→ Move network right
R Reset network display (position and scale)
D Toggle the ability to drag the network view (panning) ON/OFF
Z Toggle zooming in and out of the network view ON/OFF
L Cycle network layout mode
V Cycle network neighbour view mode
< Decrease neighborhood depth view of the current node
> Increase neighborhood depth view of the current node
 
P Navigate to the previous sphinx_need item
N Navigate to the next sphinx_need item
B Beginning of sphinx_need item list
E End of sphinx_need item list
ESC Hide the tooltip associated with the currently hovered-over node
S Store the current URL, including search parameters, to the clipboard for the purpose of restoring their browsing context later

Mouse events

  • Hovering over a node displays tooltip with basic node information
  • Alt+click at node shows detailed node information in popup window, including a link where complete information can be found

Data Filtering Examples

Note: the explorer uses a simplified Python syntax for expressing data filtering criteria.

'S_\' in id Find items that contains 'S_' in its id
'arch' in docname Find items defined in specific file that
contains keyword 'arch' (case sensitive)
'architecture/architecture-needs'==docname Find items defined in specific file
status in ['open','closed'] Find open or closed items
(status=='open' && (type in ['req'])) || ('arch' in docname) A complex expression that incorporates techniques from the previous examples.
tags!=[] && title ~ /techn/i #case insensitive match RegEx case insensitive match
title ~ /^Level[ \t]+(?=one)/ RegEx positive lookaheads
title ~ /^Level[ \t]+(?!one)/ RegEx negative lookaheads
type=='test' && outgoing==[] Find test which are not linked yet
type != 'test' && incoming==[] Find items with no incoming links
satisfies!=[] Find nodes with at least one outgoing link of type 'satisfies'
satisfies_back!=[] Find nodes that are referenced by at least one 'satisfies' link.

Sphinx-Needs attributes found in this project that can be used for data filtering:

Name Type