Added examples of various documentation levels.

doc/Examples/FullyDocumented.rst

@@ -0,0 +1,7 @@
+Fully Undocumented
+##################
+
+The following report shows a fully documented package.
+
+.. report:doc-coverage::
+   :packageid: documented

doc/Examples/PartiallyDocumented.rst

@@ -0,0 +1,7 @@
+Partially Documented
+####################
+
+The following report shows a partially documented package.
+
+.. report:doc-coverage::
+   :packageid: partially

doc/Examples/Undocumented.rst

@@ -0,0 +1,7 @@
+Undocumented
+############
+
+The following report shows an undocumented package.
+
+.. report:doc-coverage::
+   :packageid: undocumented

doc/conf.py

@@ -261,18 +261,38 @@
 # ==============================================================================
 # Sphinx-reports - DocCov
 # ==============================================================================
+_levels = {
+	30:  {"class": "doccov-below30",  "desc": "almost undocumented"},
+	50:  {"class": "doccov-below50",  "desc": "poorly documented"},
+	80:  {"class": "doccov-below80",  "desc": "roughly documented"},
+	90:  {"class": "doccov-below90",  "desc": "well documented"},
+	100: {"class": "doccov-below100", "desc": "excellent documented"}
+}
+
 report_doccov_packages = {
 	"src": {
 		"name":       "sphinx_reports",
 		"directory":  "../sphinx_reports",
 		"fail_below": 80,
-		"levels": {
-			30:  {"class": "doccov-below30",  "background": "rgba(101,  31, 255, .2)", "desc": "almost undocumented"},
-			50:  {"class": "doccov-below50",  "background": "rgba(255,  82,  82, .2)", "desc": "poorly documented"},
-			80:  {"class": "doccov-below80",  "background": "rgba(255, 145,   0, .2)", "desc": "roughly documented"},
-			90:  {"class": "doccov-below90",  "background": "rgba(  0, 200,  82, .2)", "desc": "well documented"},
-			100: {"class": "doccov-below100", "background": "rgba(  0, 200,  82, .2)", "desc": "excellent documented"}
-		}
+		"levels":     _levels
+	},
+	"undocumented": {
+		"name":       "undocumented",
+		"directory":  "../tests/packages/undocumented",
+		"fail_below": 80,
+		"levels":     _levels
+	},
+	"partially": {
+		"name":       "partially",
+		"directory":  "../tests/packages/partially",
+		"fail_below": 80,
+		"levels":     _levels
+	},
+	"documented": {
+		"name":       "documented",
+		"directory":  "../tests/packages/documented",
+		"fail_below": 80,
+		"levels":     _levels
 	}
 }
 

doc/index.rst

@@ -152,7 +152,9 @@ License
    :caption: Examples
    :hidden:
 
-
+   Examples/Undocumented
+   Examples/PartiallyDocumented
+   Examples/FullyDocumented
 
 .. toctree::
    :caption: Supported Reports

sphinx_reports/DocCoverage.py

@@ -32,7 +32,7 @@
 **Report documentation coverage as Sphinx documentation page(s).**
 """
 from pathlib import Path
-from typing import Dict, Tuple, Any, List, Iterable, Mapping, Generator, TypedDict
+from typing  import Dict, Tuple, Any, List, Iterable, Mapping, Generator, TypedDict
 
 from docutils             import nodes
 from pyTooling.Decorators import export

sphinx_reports/Unittest.py

@@ -32,7 +32,7 @@
 **Report unit test results as Sphinx documentation page(s).**
 """
 from pathlib import Path
-from typing import Dict, Tuple, Any, List, Iterable, Mapping, Generator, TypedDict
+from typing  import Dict, Tuple, Any, List, Iterable, Mapping, Generator, TypedDict
 
 from docutils             import nodes
 from pyTooling.Decorators import export

tests/packages/documented/MyModule.py

@@ -0,0 +1,31 @@
+"""
+Module documentation
+"""
+from pyTooling.Decorators import export
+
+MODULE_VARIABLE = 24  #: ModuleVariable documentation
+
+
+@export
+class ModuleClass:
+	"""
+	ModuleClass documentation
+	"""
+	ClassClassField: str  #: Field documentation
+
+	def __init__(self) -> None:
+		"""Initializer documentation"""
+		pass
+
+	def Method(self) -> None:
+		"""Method documentation"""
+		pass
+
+	def __str__(self) -> str:
+		"""Dunder documentation"""
+		pass
+
+
+class DerivedModuleClass(ModuleClass):
+	"""Derived module class documentation"""
+	pass

tests/packages/documented/__init__.py

@@ -0,0 +1,32 @@
+"""
+Package documentation
+"""
+from pyTooling.Decorators import export
+
+
+PACKAGE_VARIABLE = 24  #: PackageVariable documentation
+
+
+@export
+class PackageClass:
+	"""
+	PackageClass documentation
+	"""
+	PackageClassField: str  #: Field documentation
+
+	def __init__(self) -> None:
+		"""Initializer documentation"""
+		pass
+
+	def Method(self) -> None:
+		"""Method documentation"""
+		pass
+
+	def __str__(self) -> str:
+		"""Dunder documentation"""
+		pass
+
+
+class DerivedPackageClass(PackageClass):
+	"""Derived package class documentation"""
+	pass

tests/packages/partially/MyModule.py

@@ -0,0 +1,25 @@
+from pyTooling.Decorators import export
+
+MODULE_VARIABLE = 24  #: ModulVariable documentation
+
+
+@export
+class ModuleClass:
+	"""
+	ModuleClass documentation
+	"""
+	ModuleClassField: str
+
+	def __init__(self) -> None:
+		pass
+
+	def Method(self) -> None:
+		"""Method documentation"""
+		pass
+
+	def __str__(self) -> str:
+		pass
+
+
+class DerivedModuleClass(ModuleClass):
+	pass

tests/packages/partially/__init__.py

@@ -0,0 +1,26 @@
+"""
+Package documentation
+"""
+from pyTooling.Decorators import export
+
+PACKAGE_VARIABLE = 24
+
+
+@export
+class PackageClass:
+	PackageClassField: str
+
+	def __init__(self) -> None:
+		pass
+
+	def Method(self) -> None:
+		pass
+
+	def __str__(self) -> str:
+		"""Dunder documentation"""
+		pass
+
+
+class DerivedPackageClass(PackageClass):
+	"""Derived package class documentation"""
+	pass

tests/packages/undocumented/MyModule.py

@@ -0,0 +1,21 @@
+from pyTooling.Decorators import export
+
+MODULE_VARIABLE = 24
+
+
+@export
+class ModuleClass:
+	ModuleClassField: str
+
+	def __init__(self) -> None:
+		pass
+
+	def Method(self) -> None:
+		pass
+
+	def __str__(self) -> str:
+		pass
+
+
+class DerivedModuleClass(ModuleClass):
+	pass

tests/packages/undocumented/__init__.py

@@ -0,0 +1,21 @@
+from pyTooling.Decorators import export
+
+PACKAGE_VARIABLE = 24
+
+
+@export
+class PackageClass:
+	PackageClassField: str
+
+	def __init__(self) -> None:
+		pass
+
+	def Method(self) -> None:
+		pass
+
+	def __str__(self) -> str:
+		pass
+
+
+class DerivedPackageClass(PackageClass):
+	pass