Sphinx plugin to generate Coverity defects report or table in reStructuredText documentation. Coverity report is then personally styled while data integrity is guaranteed.
GNU General Public License v3.0
5
stars
2
forks
source link
Parse comments for custom pattern to create a hyperlink #27
When we link Coverity extension with Traceability extension that means we describe our Coverity deviations with items from traceability extension. That means comments to Coverity issues include traceability item ID which should be linked to that item (ref in docnode). Also all hyperlinks should be made links.
That means when you have traceability item in something.rst:
.. item:: DEVIATION-SOMETHING We deviate from Something rule
We want to deviate from this rule, because usage in X does not correspond to our style
of work and we think something else is a lot better.
With comment in Coverity Connect:
Triagged because DEVIATION-SOMETHING
Then final for example html output in the Coverity table under comment column should be:
Tiagged because <a href=something.html#deviation-something>DEVIATION-SOMETHING</a>
The link should be done in docnode so that also other builders can make a valid link.
You define the regex for traceability item id in the coverity.config in conf.py (or we can make default all caps with - and _ separator as a link.)
When we link Coverity extension with Traceability extension that means we describe our Coverity deviations with items from traceability extension. That means comments to Coverity issues include traceability item ID which should be linked to that item (ref in docnode). Also all hyperlinks should be made links.
That means when you have traceability item in something.rst:
With comment in Coverity Connect:
Then final for example html output in the Coverity table under comment column should be:
The link should be done in docnode so that also other builders can make a valid link.
You define the regex for traceability item id in the
coverity.config
inconf.py
(or we can make default all caps with-
and_
separator as a link.)