Documented new options.

pyTooling · Jan 24, 2024 · 2d16290 · 2d16290
1 parent d5045ab
commit 2d16290
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 7 deletions.
diff --git a/doc/CodeCov/index.rst b/doc/CodeCov/index.rst
@@ -122,6 +122,10 @@ Directives
 
       Describes if and where to add a legend. Possible values: ``no_legend``, ``top``, ``bottom``, ``both``.
 
+   .. rst:directive:option:: no-branch-coverage
+
+      If flag is present, no branch coverage columns are shown. Only statement coverage columns are present.
+
 
 .. _CODECOV/Roles:
 

diff --git a/doc/Unittest/index.rst b/doc/Unittest/index.rst
@@ -107,6 +107,10 @@ Directives
       An identifier referencing a dictionary entry in the configuration variable ``report_unittest_testsuites`` defined
       in :file:`conf.py`.
 
+   .. rst:directive:option:: no-assertions
+
+      If flag is present, no assertions column with be shown.
+
 
 .. _UNITTEST/Roles:
 

diff --git a/sphinx_reports/CodeCoverage.py b/sphinx_reports/CodeCoverage.py
@@ -303,11 +303,11 @@ def run(self) -> List[nodes.Node]:
 		container = nodes.container()
 
 		if LegendPosition.top in self._legend:
-			container += self._CreateLegend(identifier="legend1", classes=["report-doccov-legend"])
+			container += self._CreateLegend(identifier=f"{self._packageID}-top-legend", classes=["report-codecov-legend"])
 
 		container += self._GenerateCoverageTable()
 
 		if LegendPosition.bottom in self._legend:
-			container += self._CreateLegend(identifier="legend2", classes=["report-doccov-legend"])
+			container += self._CreateLegend(identifier=f"{self._packageID}-bottom-legend", classes=["report-codecov-legend"])
 
 		return [container]
diff --git a/sphinx_reports/DocCoverage.py b/sphinx_reports/DocCoverage.py
@@ -194,7 +194,11 @@ def renderlevel(tableBody: nodes.tbody, packageCoverage: PackageCoverage, level:
 				nodes.entry("", nodes.paragraph(text=f"{packageCoverage.Covered}")),
 				nodes.entry("", nodes.paragraph(text=f"{packageCoverage.Uncovered}")),
 				nodes.entry("", nodes.paragraph(text=f"{packageCoverage.Coverage:.1%}")),
-				classes=["report-doccov-table-row", self._ConvertToColor(packageCoverage.Coverage, "class")],
+				classes=[
+					"report-doccov-table-row",
+					"report-doccov-package",
+					self._ConvertToColor(packageCoverage.Coverage, "class")
+				],
 			)
 
 			for package in sortedValues(packageCoverage._packages):
@@ -208,7 +212,11 @@ def renderlevel(tableBody: nodes.tbody, packageCoverage: PackageCoverage, level:
 					nodes.entry("", nodes.paragraph(text=f"{module.Covered}")),
 					nodes.entry("", nodes.paragraph(text=f"{module.Uncovered}")),
 					nodes.entry("", nodes.paragraph(text=f"{module.Coverage :.1%}")),
-					classes=["report-doccov-table-row", self._ConvertToColor(module.Coverage, "class")],
+					classes=[
+						"report-doccov-table-row",
+						"report-doccov-module",
+						self._ConvertToColor(module.Coverage, "class")
+					],
 				)
 
 		renderlevel(tableBody, self._coverage)
@@ -223,7 +231,11 @@ def renderlevel(tableBody: nodes.tbody, packageCoverage: PackageCoverage, level:
 			nodes.entry("", nodes.paragraph(text=f"{self._coverage.AggregatedCoverage:.1%}"),
 				# classes=[self._ConvertToColor(self._coverage.coverage(), "class")]
 			),
-			classes=["report-doccov-summary-row", self._ConvertToColor(self._coverage.AggregatedCoverage, "class")]
+			classes=[
+				"report-doccov-table-row",
+				"report-doccov-summary",
+				self._ConvertToColor(self._coverage.AggregatedCoverage, "class")
+			]
 		)
 
 		return table
@@ -274,11 +286,11 @@ def run(self) -> List[nodes.Node]:
 		container = nodes.container()
 
 		if LegendPosition.top in self._legend:
-			container += self._CreateLegend(identifier="legend1", classes=["report-doccov-legend"])
+			container += self._CreateLegend(identifier=f"{self._packageID}-top-legend", classes=["report-doccov-legend"])
 
 		container += self._GenerateCoverageTable()
 
 		if LegendPosition.bottom in self._legend:
-			container += self._CreateLegend(identifier="legend2", classes=["report-doccov-legend"])
+			container += self._CreateLegend(identifier=f"{self._packageID}-bottom-legend", classes=["report-doccov-legend"])
 
 		return [container]