Traceability matrix - Githubissues

add a traceability matrix feature.

A traceability matrix is used to show links and coverage from parents to children. For example, to show the links and coverage between requirements and their associated test cases.

For use in this library, this can be a bit more generic.

both 'parents' and 'children' can be the result of arbitrary queries
a 'link' need not be direct, so a link would show whether or not one node was an ancestor/descendent of another (ie. separated by multiple 'generations')
it's an error for one of the nodes in the 'parent' query to be a descendent of one of the nodes in the 'child' query (and vice versa)

so i'm imagining a directive like the following-

.. vertex-matrix::
    :parents: parent-query
    :children: child-query

    [parents]
    key1 = value1

    [children] 
    key2 = value2
    key3 = value3

where the query names are defined in the config, and key-value pairs can be injected using toml in the body of the directive.

In practice you'd have a default query with some sensible kwargs, so you'd have something like

.. vertex-matrix::

    [parents]
    type = "USR"

    [children] 
    type = "SYS"

or, equivalently-

.. vertex-matrix::

    parents = { type = "USR" }  
    children = { type = "SYS" }

this would output a table vaguely like the following -

with the results of each query being the row and column headers, and the value of each cell being determined by the relationship between the two corresponding nodes.

danieleades / sphinx-graph

Traceability matrix #89