Releases: melexis/sphinx-coverity-extension
Support Sphinx 2.1+
Add support for sphinx 2.1+ and drop support for the Python 2.7 which goes deprecated in few months.
Prompt for Coverity username and password if not in variables
When you do not have the username and password as a local variable or you do not pipe them to the build elsewhere then plugin prompts you for both, so that you can guard your password better.
Major code refactoring
Plugin code got shuffled around and more documentation was provided to ease new contributions. Also maintainability is now graded as A and most of the issues were fixed. This is now a great base for future development.
While testing was done after refactoring there still might be some issues, so we are bumping minor version to alert all users about this.
Add location as table option
When we do not want to have CID as a unique link towards Coverity Connect or when Coverity Connect is not reachable by person reading the documentation, the Location column can be used which describes filename and line number.
Also included is a bugfix as parameters for filters were wrongly passed.
Check also external reference and create links
External reference field in Coverity is meant to be used to provide references to external documents. Instead of parsing comments for links (still need to parse for url links), you can also add Traceability item IDs into the Ext. Reference field, which will then be automatically created as link.
Sometimes last comment is overwritten, so the reference might get lost, but Ext. Reference field should be stable enough.
More informative warning's message
CID is added to warnings message and some improvements to docs.
Add more functionality to chart option
-
Make
:chart:
option more advanced with :- Allow a colon-separated
<<attribute>>
parameter. - Add an alternative to a list of attribute values: a threshold value for grouping defects with the same attribute value if their amount reaches the threshold value.
- Allow a colon-separated
-
Fix cut off labels in pie chart image when labels are too long by increasing pie chart width from 8 to 10.
-
Update User documentation.
Make links in comments real links
Since comments in Coverity can contain URLs or references to items produced by mlx.traceability
plugin and those links are now made proper links. That means you can provide explanation within item of traceability plugin and then just use this itemId in Coverity comment to link triage explanation to your documentation.
There might be some deficiency with the pdf output of more complex tables.
Adding graph/chart support
Draw a graph displaying each of the represented classifications. You can also omit table and only draw a graph. See more in examples/index.rst.
Adding Longtable support for better pdf rendering
For decent pdf rendering (fit to page and continuation through multiple pages) every table needs to be marked as a longtable. This does not affect the html output at all, but provides a nice fit to pdf page.
While existing blocks will default to auto width table, the :width:
attribute enables you to define column widths in percentage.