v0.9.1

Author: Paebbels

.github/workflows/Pipeline.yml

@@ -9,14 +9,11 @@ on:
 
 jobs:
   Pipeline:
-    uses: pyTooling/Actions/.github/workflows/CompletePipeline.yml@r4
+    uses: pyTooling/Actions/.github/workflows/CompletePipeline.yml@dev
     with:
       package_name: sphinx_reports
       unittest_python_version_list: '3.11 3.12 3.13'
       codecov: true
       codacy:  true
       dorny:   true
-    secrets:
-      PYPI_TOKEN:           ${{ secrets.PYPI_TOKEN }}
-      CODECOV_TOKEN:        ${{ secrets.CODECOV_TOKEN }}
-      CODACY_PROJECT_TOKEN: ${{ secrets.CODACY_PROJECT_TOKEN }}
+    secrets: inherit

doc/CodeCov/index.rst

@@ -153,6 +153,8 @@ The second file shows how to integrate that document into the navigation bar / *
 
    .. code-block:: ReST
 
+      .. _CODECOV:
+
       Code Coverage Report
       ####################
 
@@ -187,7 +189,7 @@ The second file shows how to integrate that document into the navigation bar / *
          Python Class Reference <sphinx_reports/sphinx_reports>
          Unittest
          CodeCoverage
-         DocCoverage
+         Doc. Coverage Report <DocCoverage>
          Static Type Check Report ➚ <typing/index>
 
       .. toctree::

doc/CodeCoverage.rst

@@ -1,3 +1,5 @@
+.. _CODECOV:
+
 Code Coverage Report
 ####################
 

doc/Dependency.rst

@@ -166,7 +166,7 @@ the mandatory dependencies too.
 +-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
 | `sphinx-copybutton <https://GitHub.com/executablebooks/sphinx-copybutton>`__                    | ≥0.5         | `MIT <https://GitHub.com/executablebooks/sphinx-copybutton/blob/master/LICENSE>`__                       | *Not yet evaluated.*                                                                                                                                 |
 +-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
-| `sphinx_autodoc_typehints <https://GitHub.com/agronholm/sphinx-autodoc-typehints>`__            | ≥3.1         | `MIT <https://GitHub.com/agronholm/sphinx-autodoc-typehints/blob/master/LICENSE>`__                      | *Not yet evaluated.*                                                                                                                                 |
+| `sphinx_autodoc_typehints <https://GitHub.com/agronholm/sphinx-autodoc-typehints>`__            | ≥3.2         | `MIT <https://GitHub.com/agronholm/sphinx-autodoc-typehints/blob/master/LICENSE>`__                      | *Not yet evaluated.*                                                                                                                                 |
 +-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
 
 .. TODO:: document the usage of

doc/DocCov/index.rst

@@ -150,6 +150,8 @@ The second file shows how to integrate that document into the navigation bar / *
 
    .. code-block:: ReST
 
+      .. _DOCCOV:
+
       Documentation Coverage Report
       #############################
 
@@ -184,7 +186,7 @@ The second file shows how to integrate that document into the navigation bar / *
          Python Class Reference <sphinx_reports/sphinx_reports>
          Unittest
          CodeCoverage
-         DocCoverage
+         Doc. Coverage Report <DocCoverage>
          Static Type Check Report ➚ <typing/index>
 
       .. toctree::

doc/DocCoverage.rst

@@ -1,3 +1,5 @@
+.. _DOCCOV:
+
 Documentation Coverage Report
 #############################
 

doc/Overview.rst

@@ -48,7 +48,7 @@ See the following :file:`doc/requirements.txt` file as an example with commonly
       autoapi ~= 2.0.1
       sphinx_design ~= 0.6.1
       sphinx-copybutton ~= 0.5.2
-      sphinx_autodoc_typehints ~= 3.1
+      sphinx_autodoc_typehints ~= 3.2
       sphinx_reports ~= 1.0             # <= new entry
 
 Finally, the extension needs to be enabled in Sphinx's :file:`conf.py`, so the extension is loaded by Sphinx.

doc/Unittest/index.rst

@@ -163,7 +163,7 @@ The second file shows how to integrate that document into the navigation bar / *
          Python Class Reference <sphinx_reports/sphinx_reports>
          Unittest
          CodeCoverage
-         DocCoverage
+         Doc. Coverage Report <DocCoverage>
          Static Type Check Report ➚ <typing/index>
 
       .. toctree::

doc/conf.py

@@ -1,7 +1,6 @@
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-from importlib.util import find_spec
 from sys import path as sys_path
 from os.path import abspath
 from pathlib import Path
@@ -24,8 +23,9 @@
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 project = "sphinx_reports"
+directoryName = project.replace('.', '/')
 
-packageInformationFile = Path(f"../{project.replace('.', '/')}/__init__.py")
+packageInformationFile = Path(f"../{directoryName}/__init__.py")
 versionInformation = extractVersionInformation(packageInformationFile)
 
 author =    versionInformation.Author
@@ -271,7 +271,7 @@
 
 report_codecov_packages = {
 	"src": {
-		"name":        "sphinx_reports",
+		"name":        f"{project}",
 		"json_report": "../report/coverage/coverage.json",
 		"fail_below":  80,
 		"levels":      "default"
@@ -280,8 +280,8 @@
 
 report_doccov_packages = {
 	"src": {
-		"name":       "sphinx_reports",
-		"directory":  "../sphinx_reports",
+		"name":       f"{project}",
+		"directory":  f"../{directoryName}",
 		"fail_below": 80,
 		"levels":     "default"
 	},

doc/index.rst

@@ -240,7 +240,7 @@ License
    unittests/index
    coverage/index
    CodeCoverage
-   DocCoverage
+   Doc. Coverage Report <DocCoverage>
    Static Type Check Report ➚ <typing/index>
 
 .. raw:: latex

doc/requirements.txt

@@ -6,11 +6,11 @@ docutils ~= 0.21
 docutils_stubs ~= 0.0.22
 
 # ReadTheDocs Theme
-sphinx_rtd_theme ~= 3.0.1
+sphinx_rtd_theme ~= 3.0
 
 # Sphinx Extenstions
 sphinxcontrib-mermaid ~= 1.0
 autoapi ~= 2.0.1
 sphinx_design ~= 0.6.1
 sphinx-copybutton ~= 0.5.2
-sphinx_autodoc_typehints ~= 3.1
+sphinx_autodoc_typehints ~= 3.2

pyproject.toml

@@ -1,6 +1,6 @@
 [build-system]
 requires = [
-  "setuptools ~= 78.1",
+  "setuptools ~= 79.0",
   "wheel ~= 0.45",
   "pyTooling ~= 8.4"
 ]

requirements.txt

@@ -1,5 +1,5 @@
 pyTooling >= 6.7, <9.0
-pyEDAA.Reports ~= 0.14
+pyEDAA.Reports ~= 0.15
 
 sphinx ~= 8.2
 docutils ~= 0.21

run.ps1

@@ -32,6 +32,7 @@ Param(
 )
 
 $PackageName = "sphinx_reports"
+$PackageVersion = "0.9.1"
 
 # set default values
 $EnableDebug =        [bool]$PSCmdlet.MyInvocation.BoundParameters["Debug"]
@@ -97,7 +98,7 @@ if ($install)
   { Write-Host -ForegroundColor Cyan     "[ADMIN][UNINSTALL] Uninstalling $PackageName ..."
     py -3.13 -m pip uninstall -y $PackageName
     Write-Host -ForegroundColor Cyan     "[ADMIN][INSTALL]   Installing $PackageName from wheel ..."
-    py -3.13 -m pip install .\dist\$PackageName-0.8.0-py3-none-any.whl
+    py -3.13 -m pip install .\dist\$PackageName-$PackageVersion-py3-none-any.whl
 
     Write-Host -ForegroundColor Cyan     "[ADMIN][INSTALL]   Closing window in 5 seconds ..."
     Start-Sleep -Seconds 5

sphinx_reports/__init__.py

@@ -43,7 +43,7 @@
 __email__ =     "[email protected]"
 __copyright__ = "2023-2025, Patrick Lehmann"
 __license__ =   "Apache License, Version 2.0"
-__version__ =   "0.9.0"
+__version__ =   "0.9.1"
 __keywords__ =  [
 	"Python3", "Sphinx", "Extension", "Report", "doc-string", "interrogate", "Code Coverage", "Coverage",
 	"Documentation Coverage", "Unittest", "Dependencies", "Summary"
@@ -60,14 +60,13 @@
 from sphinx.config         import Config
 from sphinx.domains        import Domain
 from sphinx.environment    import BuildEnvironment
+from sphinx.util.logging   import getLogger
 from pyTooling.Decorators  import export
 from pyTooling.Common      import readResourceFile
-from sphinx.util.logging import getLogger
 
+from sphinx_reports        import static as ResourcePackage
 from sphinx_reports.Common import ReportExtensionError
 
-from sphinx_reports import static as ResourcePackage
-
 
 @export
 class ReportDomain(Domain):