v0.11.0

.github/dependabot.yml

@@ -10,3 +10,16 @@ updates:
       - Dependencies
     schedule:
       interval: "daily"    # Checks on Monday trough Friday.
+
+  # Maintain GitHub Action runners
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    target-branch: dev
+    commit-message:
+      prefix: "[Dependabot]"
+    labels:
+      - Dependencies
+    assignees:
+      - Paebbels
+    schedule:
+      interval: "daily"    # Checks on Monday trough Friday.

.github/workflows/Pipeline.yml

@@ -7,18 +7,25 @@ on:
 # Every Friday at 22:00 - rerun pipeline to check for dependency-based issues
     - cron: '0 22 * * 5'
 
+permissions:
+  actions:  write
+  contents: write
+  pages:    write
+  id-token: write
+
 jobs:
   Pipeline:
     uses: pyTooling/Actions/.github/workflows/CompletePipeline.yml@r7
     with:
       package_name: 'sphinx_reports'
-      unittest_python_version_list: '3.11 3.12 3.13 3.14'
+      unittest_python_version_list: '3.12 3.13 3.14'   # dropped 3.11 due to Sphinx 9.1 dropping 3.11
       unittest_disable_list:        'windows-arm:* windows-arm:pypy-3.11'
       bandit:       'true'
       pylint:       'false'
       codecov:      'true'
       codacy:       'true'
       dorny:        'true'
+      documentation_steps: 'html latex pdf pages'
     secrets:
       PYPI_TOKEN:    ${{ secrets.PYPI_TOKEN }}
       CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

README.md

@@ -1,7 +1,7 @@
 [![Sourcecode on GitHub](https://img.shields.io/badge/pyTooling-sphinx--reports-323131.svg?logo=github&longCache=true)](https://github.com/pyTooling/sphinx-reports)
 [![Sourcecode License](https://img.shields.io/pypi/l/sphinx-reports?longCache=true&style=flat-square&logo=Apache&label=code)](LICENSE.md)
 [![Documentation](https://img.shields.io/website?longCache=true&style=flat-square&label=pyTooling.github.io%2Fsphinx-reports&logo=GitHub&logoColor=fff&up_color=blueviolet&up_message=Read%20now%20%E2%9E%9A&url=https%3A%2F%2FpyTooling.github.io%2Fsphinx%2Dreports%2Findex.html)](https://pyTooling.github.io/sphinx-reports/)
-[![Documentation License](https://img.shields.io/badge/doc-CC--BY%204.0-green?longCache=true&style=flat-square&logo=CreativeCommons&logoColor=fff)](LICENSE.md)  
+[![Documentation License](https://img.shields.io/badge/doc-CC--BY%204.0-green?longCache=true&style=flat-square&logo=CreativeCommons&logoColor=fff)](doc/Doc-License.rst)  
 [![PyPI](https://img.shields.io/pypi/v/sphinx-reports?longCache=true&style=flat-square&logo=PyPI&logoColor=FBE072)](https://pypi.org/project/sphinx-reports/)
 ![PyPI - Status](https://img.shields.io/pypi/status/sphinx-reports?longCache=true&style=flat-square&logo=PyPI&logoColor=FBE072)
 ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/sphinx-reports?longCache=true&style=flat-square&logo=PyPI&logoColor=FBE072)  

dist/requirements.txt

@@ -1,2 +1,2 @@
-wheel ~= 0.45.0
+wheel ~= 0.46.3
 twine ~= 6.2

doc/CodeCov/index.rst

@@ -1,4 +1,4 @@
-.. _CODECOV:
+.. _CODECOVER:
 
 Code Coverage
 #############
@@ -10,7 +10,7 @@ Code Coverage
 
       The :rst:dir:`report:code-coverage` directive generates a code coverage report summary table. The code coverage
       report file(s) need to be configured in Sphinx's ``conf.py`` for pre-analysis and data aggregation
-      (:ref:`see below <CODECOV/Config>` for details). This also allows the directive to supports multiple code coverage
+      (:ref:`see below <CODECOVER/Config>` for details). This also allows the directive to supports multiple code coverage
       reports per Sphinx documentation. Each code coverage report is referenced by the
       :rst:dir:`reportid <report:code-coverage:reportid>` option, which matches the dictionary key used in the
       configuration file.
@@ -62,7 +62,7 @@ Code Coverage
          .. image:: ../_static/CodeCoverage.png
 
 
-.. _CODECOV/Config:
+.. _CODECOVER/Config:
 
 Configuration Entries in :file:`conf.py`
 ****************************************
@@ -134,7 +134,7 @@ Configuration Entries in :file:`conf.py`
                }
 
 
-.. _CODECOV/Example:
+.. _CODECOVER/Example:
 
 Example Document
 ****************
@@ -197,7 +197,7 @@ The second file shows how to integrate that document into the navigation bar / *
          :hidden:
 
 
-.. _CODECOV/Directives:
+.. _CODECOVER/Directives:
 
 Sphinx Directives
 *****************
@@ -249,15 +249,15 @@ The following directives are provided for visualizing code coverage reports.
 
 
 
-.. _CODECOV/Roles:
+.. _CODECOVER/Roles:
 
 Sphinx Roles
 ************
 
 *There are no roles defined.*
 
 
-.. _CODECOV/ColorPalett:
+.. _CODECOVER/ColorPalett:
 
 Color Paletts
 *************
@@ -289,7 +289,7 @@ Color Paletts
                :width: 350 px
 
 
-.. _CODECOV/Styling:
+.. _CODECOVER/Styling:
 
 Custom CSS Styling
 ******************

doc/Dependency.rst

@@ -3,14 +3,27 @@
 Dependencies
 ############
 
-.. |img-pyTooling-lib-status| image:: https://img.shields.io/librariesio/release/pypi/sphinx-reports
-   :alt: Libraries.io status for latest release
-   :height: 22
-   :target: https://libraries.io/github/pyTooling/sphinx-reports
-.. |img-pyTooling-vul-status| image:: https://img.shields.io/snyk/vulnerabilities/github/pyTooling/sphinx-reports
-   :alt: Snyk Vulnerabilities for GitHub Repo
-   :height: 22
-   :target: https://img.shields.io/snyk/vulnerabilities/github/pyTooling/sphinx-reports
+.. only:: html
+
+   .. |img-pyTooling-lib-status| image:: https://img.shields.io/librariesio/release/pypi/sphinx-reports
+      :alt: Libraries.io status for latest release
+      :height: 22
+      :target: https://libraries.io/github/pyTooling/sphinx-reports
+   .. |img-pyTooling-vul-status| image:: https://img.shields.io/snyk/vulnerabilities/github/pyTooling/sphinx-reports
+      :alt: Snyk Vulnerabilities for GitHub Repo
+      :height: 22
+      :target: https://raster.shields.io/snyk/vulnerabilities/github/pyTooling/sphinx-reports
+
+.. only:: latex
+
+   .. |img-pyTooling-lib-status| image:: https://raster.shields.io/librariesio/release/pypi/sphinx-reports
+      :alt: Libraries.io status for latest release
+      :height: 22
+      :target: https://libraries.io/github/pyTooling/sphinx-reports
+   .. |img-pyTooling-vul-status| image:: https://raster.shields.io/snyk/vulnerabilities/github/pyTooling/sphinx-reports
+      :alt: Snyk Vulnerabilities for GitHub Repo
+      :height: 22
+      :target: https://raster.shields.io/snyk/vulnerabilities/github/pyTooling/sphinx-reports
 
 +------------------------------------------+------------------------------------------+
 | `Libraries.io <https://libraries.io/>`_  | Vulnerabilities Summary                  |
@@ -104,7 +117,7 @@ the mandatory dependencies too.
 +=====================================================================+=============+========================================================================================+======================+
 | `pytest <https://GitHub.com/pytest-dev/pytest>`__                   | ≥9.0        | `MIT <https://GitHub.com/pytest-dev/pytest/blob/master/LICENSE>`__                     | *Not yet evaluated.* |
 +---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
-| `pytest-cov <https://GitHub.com/pytest-dev/pytest-cov>`__           | ≥7.0        | `MIT <https://GitHub.com/pytest-dev/pytest-cov/blob/master/LICENSE>`__                 | *Not yet evaluated.* |
+| `pytest-cov <https://GitHub.com/pytest-dev/pytest-cov>`__           | ≥7.1        | `MIT <https://GitHub.com/pytest-dev/pytest-cov/blob/master/LICENSE>`__                 | *Not yet evaluated.* |
 +---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
 | `Coverage <https://GitHub.com/nedbat/coveragepy>`__                 | ≥7.13       | `Apache License, 2.0 <https://GitHub.com/nedbat/coveragepy/blob/master/LICENSE.txt>`__ | *Not yet evaluated.* |
 +---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
@@ -154,19 +167,19 @@ the mandatory dependencies too.
 +=================================================================================================+==============+==========================================================================================================+======================================================================================================================================================+
 | `pyTooling <https://GitHub.com/pyTooling/pyTooling>`__                                          | ≥8.11        | `Apache License, 2.0 <https://GitHub.com/pyTooling/pyTooling/blob/main/LICENSE.md>`__                    | *None*                                                                                                                                               |
 +-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
-| `Sphinx <https://GitHub.com/sphinx-doc/sphinx>`__                                               | ≥9.0         | `BSD 3-Clause <https://GitHub.com/sphinx-doc/sphinx/blob/master/LICENSE>`__                              | *Not yet evaluated.*                                                                                                                                 |
+| `Sphinx <https://GitHub.com/sphinx-doc/sphinx>`__                                               | ≥9.1         | `BSD 3-Clause <https://GitHub.com/sphinx-doc/sphinx/blob/master/LICENSE>`__                              | *Not yet evaluated.*                                                                                                                                 |
 +-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
 | `sphinx_rtd_theme <https://GitHub.com/readthedocs/sphinx_rtd_theme>`__                          | ≥3.1         | `MIT <https://GitHub.com/readthedocs/sphinx_rtd_theme/blob/master/LICENSE>`__                            | *Not yet evaluated.*                                                                                                                                 |
 +-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
 | `sphinxcontrib-mermaid <https://GitHub.com/mgaitan/sphinxcontrib-mermaid>`__                    | ≥2.0         | `BSD <https://GitHub.com/mgaitan/sphinxcontrib-mermaid/blob/master/LICENSE.rst>`__                       | *Not yet evaluated.*                                                                                                                                 |
 +-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
 | `autoapi <https://GitHub.com/carlos-jenkins/autoapi>`__                                         | ≥2.0.1       | `Apache License, 2.0 <https://GitHub.com/carlos-jenkins/autoapi/blob/master/LICENSE>`__                  | *Not yet evaluated.*                                                                                                                                 |
 +-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
-| `sphinx_design <https://GitHub.com/executablebooks/sphinx-design>`__                            | ≥0.6         | `MIT <https://GitHub.com/executablebooks/sphinx-design/blob/main/LICENSE>`__                             | *Not yet evaluated.*                                                                                                                                 |
+| `sphinx_design <https://GitHub.com/executablebooks/sphinx-design>`__                            | ≥0.7         | `MIT <https://GitHub.com/executablebooks/sphinx-design/blob/main/LICENSE>`__                             | *Not yet evaluated.*                                                                                                                                 |
 +-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
 | `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.6         | `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.10        | `MIT <https://GitHub.com/agronholm/sphinx-autodoc-typehints/blob/master/LICENSE>`__                      | *Not yet evaluated.*                                                                                                                                 |
 +-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
 
 .. TODO:: document the usage of

doc/DocCov/index.rst

@@ -1,4 +1,4 @@
-.. _DOCCOV:
+.. _DOCCOVER:
 
 Documentation Coverage
 ######################
@@ -10,7 +10,7 @@ Documentation Coverage
 
       The :rst:dir:`report:doc-coverage` directive generates a documentation coverage report summary table. The
       documentation coverage reports need to be configured in Sphinx's ``conf.py`` for pre-analysis and data aggregation
-      (:ref:`see below <DOCCOV/Config>` for details). This also allows the directive to supports multiple documentation
+      (:ref:`see below <DOCCOVER/Config>` for details). This also allows the directive to supports multiple documentation
       coverage reports per Sphinx documentation. Each documentation coverage report is referenced by the
       :rst:dir:`reportid <report:doc-coverage:reportid>` option, which matches the dictionary key used in the
       configuration file.
@@ -55,7 +55,7 @@ Documentation Coverage
          .. image:: ../_static/DocCoverage.png
 
 
-.. _DOCCOV/Config:
+.. _DOCCOVER/Config:
 
 Configuration Entries in :file:`conf.py`
 ****************************************
@@ -130,7 +130,7 @@ Configuration Entries in :file:`conf.py`
                }
 
 
-.. _DOCCOV/Example:
+.. _DOCCOVER/Example:
 
 Example Document
 ****************
@@ -150,7 +150,7 @@ The second file shows how to integrate that document into the navigation bar / *
 
    .. code-block:: ReST
 
-      .. _DOCCOV:
+      .. _DOCCOVER:
 
       Documentation Coverage Report
       #############################
@@ -194,7 +194,7 @@ The second file shows how to integrate that document into the navigation bar / *
          :hidden:
 
 
-.. _DOCCOV/Directives:
+.. _DOCCOVER/Directives:
 
 Sphinx Directives
 *****************
@@ -241,15 +241,15 @@ The following directives are provided for visualizing documentation coverage rep
       * ``vertical-table``
 
 
-.. _DOCCOV/Roles:
+.. _DOCCOVER/Roles:
 
 Sphinx Roles
 ************
 
 *There are no roles defined.*
 
 
-.. _DOCCOV/ColorPalett:
+.. _DOCCOVER/ColorPalett:
 
 Color Paletts
 *************

doc/Overview.rst

@@ -47,8 +47,8 @@ See the following :file:`doc/requirements.txt` file as an example with commonly
       sphinxcontrib-mermaid ~= 2.0
       autoapi ~= 2.0.1
       sphinx_design ~= 0.7.0
-      sphinx-copybutton ~= 0.5.0
-      sphinx_autodoc_typehints ~= 3.6
+      sphinx-copybutton ~= 0.5.2
+      sphinx_autodoc_typehints ~= 3.10
       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

@@ -1,4 +1,4 @@
-.. _UNITTEST:
+.. _UNITTESTING:
 
 Unit Test Summary
 #################
@@ -10,7 +10,7 @@ Unit Test Summary
 
       The :rst:dir:`report:unittest-summary` directive generates a unittest report summary table. The unittest report
       file(s) need to be configured in Sphinx's ``conf.py`` for pre-analysis and data aggregation
-      (:ref:`see below <UNITTEST/Config>` for details). This also allows the directive to supports multiple unittest
+      (:ref:`see below <UNITTESTING/Config>` for details). This also allows the directive to supports multiple unittest
       reports per Sphinx documentation. Each unittest report is referenced by the
       :rst:dir:`report <report:unittest-summary:reportid>` option, which matches the dictionary key used in the
       configuration file.
@@ -72,15 +72,15 @@ Unit Test Summary
 
          .. tab-item:: Only Testsuites
 
-            .. image:: ../_static/Unittest_OnlyTestsuites.png
+            .. #image:: ../_static/Unittest_OnlyTestsuites.png
 
          .. tab-item:: Testsuites and Testcases
             :selected:
 
             .. image:: ../_static/Unittest.png
 
 
-.. _UNITTEST/Config:
+.. _UNITTESTING/Config:
 
 Configuration Entries in :file:`conf.py`
 ****************************************
@@ -120,7 +120,7 @@ Configuration Entries in :file:`conf.py`
             }
 
 
-.. _UNITTEST/Example:
+.. _UNITTESTING/Example:
 
 Example Document
 ****************
@@ -171,7 +171,7 @@ The second file shows how to integrate that document into the navigation bar / *
          :hidden:
 
 
-.. _UNITTEST/Directives:
+.. _UNITTESTING/Directives:
 
 Sphinx Directives
 *****************
@@ -213,7 +213,7 @@ The following directives are provided for visualizing unittest reports.
 
 
 
-.. _UNITTEST/Roles:
+.. _UNITTESTING/Roles:
 
 Sphinx Roles
 ************
@@ -222,7 +222,7 @@ Sphinx Roles
 
 
 
-.. _UNITTEST/Styling:
+.. _UNITTESTING/Styling:
 
 Custom CSS Styling
 ******************