search

melexis / sphinx-coverity-extension

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

Create pie-chart where you group items based on col attribte #20

Closed Letme closed 5 years ago

Letme commented 5 years ago

We would like to add a new attribute :chart: to coverity-list directive (or a new directive altogether) which would draw a chart (count number of same elements) of the data inside one column which is already filtered by classification.

For example:

.. coverity-list:: New Coverity issues
        :col: CID,Classification,Component,Checker,Comment
        :classification: Pending,Unclassified
        :chart: Component

should draw a graph where number of items in col labeled Component would be displayed in a pie-chart.

You might also consider :chart: as a regex for any custom grouping (all MISRA vs other issues).

.. coverity-chart:: New Coverity issues
        :col: Checker
        :classification: Pending,Unclassified
        :chart: MISRA C-2012 Rule,MISRA C-2012 Directive

which should draw graph where everything starting with MISRA C-2012 Rule is grouped together and everything starting with MISRA C-2012 Directive is grouped together and Others are in other.

Letme commented 5 years ago

While this was implemented in #24 and #26 there is still a README missing a chart attribute explanation.

Might be good to also add more info about the regex option.