v0.7.0

pyTooling · Oct 12, 2024 · d1939bb · d1939bb
2 parents edada68 + d5b8bed
commit d1939bb
Show file tree

Hide file tree

Showing 59 changed files with 1,647 additions and 1,639 deletions.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -1,8 +1,30 @@
 # New Features
+
+* tbd
 * tbd
 
 # Changes
+
+* tbd
 * tbd
 
 # Bug Fixes
+
+* tbd
+* tbd
+
+# Documentation
+
+* tbd
+* tbd
+
+# Unit Tests
+
+* tbd
+* tbd
+
+----------
+# Related Issues and Pull-Requests
+
+* tbd
 * tbd
diff --git a/.github/workflows/Pipeline.yml b/.github/workflows/Pipeline.yml
@@ -12,11 +12,11 @@ jobs:
     uses: pyTooling/Actions/.github/workflows/Parameters.yml@r1
     with:
       name: sphinx-reports
-      python_version_list: "3.9 3.10 3.11 3.12 pypy-3.9 pypy-3.10"
+      python_version_list: "3.10 3.11 3.12 pypy-3.10"
 #      disable_list: "windows:pypy-3.8 windows:pypy-3.9 windows:pypy-3.10"
 
   UnitTesting:
-    uses: pyTooling/Actions/.github/workflows/UnitTesting.yml@r1
+    uses: pyTooling/Actions/.github/workflows/UnitTesting.yml@dev
     needs:
       - UnitTestingParams
     with:

diff --git a/.idea/sphinx-reports.iml b/.idea/sphinx-reports.iml
diff --git a/dist/requirements.txt b/dist/requirements.txt
@@ -1,2 +1,2 @@
-wheel >= 0.40.0
-twine >= 4.0.2
+wheel ~= 0.44
+twine ~= 5.1
diff --git a/doc/CodeCov/index.rst b/doc/CodeCov/index.rst
@@ -23,7 +23,7 @@ See the :ref:`overview page <OVER>` on how to setup and enable the Sphinx extens
    directive. Here, the ID is called ``src`` (dictionary key). Each analysis report needs 4 configuration entries:
 
    ``name``
-     Name of the Python package[#PkgNameVsPkgDir]_.
+     Name of the Python package [#PkgNameVsPkgDir]_.
 
    ``json_report``
      The code coverage report as JSON file as generated by *Coverage.py*.
@@ -55,7 +55,7 @@ See the :ref:`overview page <OVER>` on how to setup and enable the Sphinx extens
          }
       }
 
-2. Add the :rst:dir:`code-coverage` directive into your Restructured Text (ReST) document.
+2. Add the :rst:dir:`report:code-coverage` directive into your Restructured Text (ReST) document.
 
    .. code-block:: ReST
 
@@ -68,7 +68,7 @@ See the :ref:`overview page <OVER>` on how to setup and enable the Sphinx extens
 Example Document
 ****************
 
-The following ``coverage/index`` document is an example on how this documentation uses the :rst:dir:`code-coverage`
+The following ``coverage/index`` document is an example on how this documentation uses the :rst:dir:`report:code-coverage`
 directive. The first file consists of three parts: At first, a headline; at second second a short introduction paragraph
 and at third, the report generating directive. The second file shows how to integrate that document into the navigation
 bar.
@@ -109,7 +109,7 @@ bar.
 Directives
 **********
 
-.. rst:directive:: code-coverage
+.. rst:directive:: report:code-coverage
 
    Add a table summarizing the code coverage per Python source code file (packages and/or modules).
 
@@ -118,9 +118,22 @@ Directives
       An identifier referencing a dictionary entry in the configuration variable ``report_codecov_packages`` defined in
       :file:`conf.py`.
 
-   .. rst:directive:option:: legend
+   .. rst:directive:option:: no-branch-coverage
+
+      If flag is present, no branch coverage columns are shown. Only statement coverage columns are present.
+
+.. rst:directive:: report:code-coverage-legend
+
+   .. rst:directive:option:: style
+
+      Specifies the legend style. Default is ``horizontal-table``.
+
+      Possible values:
+
+      * ``default``
+      * ``horizontal-table``
+      * ``vertical-table``
 
-      Describes if and where to add a legend. Possible values: ``no_legend``, ``top``, ``bottom``, ``both``.
 
 
 .. _CODECOV/Roles:

diff --git a/doc/Dependency.rst b/doc/Dependency.rst
diff --git a/doc/Doc-License.rst b/doc/Doc-License.rst
@@ -17,7 +17,7 @@ licensed under their terms and conditions, or any related information. Creative
 Commons disclaims all liability for damages resulting from their use to the
 fullest extent possible.
 
-.. topic:: Using Creative Commons Public Licenses
+.. rubric:: Using Creative Commons Public Licenses
 
    Creative Commons public licenses provide a standard set of terms and conditions
    that creators and other rights holders may use to share original works of

diff --git a/doc/DocCov/index.rst b/doc/DocCov/index.rst
@@ -31,7 +31,7 @@ See the :ref:`overview page <OVER>` on how to setup and enable the Sphinx extens
    the report directive. Here, the ID is called ``src`` (dictionary key). Each package needs 4 configuration entries:
 
    ``name``
-     Name of the Python package[#PkgNameVsPkgDir]_.
+     Name of the Python package [#PkgNameVsPkgDir]_.
 
    ``directory``
      The directory of the package to analyze.
@@ -63,7 +63,7 @@ See the :ref:`overview page <OVER>` on how to setup and enable the Sphinx extens
          }
       }
 
-2. Add the :rst:dir:`doc-coverage` directive into your Restructured Text (ReST) document.
+2. Add the :rst:dir:`report:doc-coverage` directive into your Restructured Text (ReST) document.
 
    .. code-block:: ReST
 
@@ -76,7 +76,7 @@ See the :ref:`overview page <OVER>` on how to setup and enable the Sphinx extens
 Example Document
 ****************
 
-The following ``DocCoverage`` document is an example on how this documentation uses the :rst:dir:`doc-coverage`
+The following ``DocCoverage`` document is an example on how this documentation uses the :rst:dir:`report:doc-coverage`
 directive. The first file consists of three parts: At first, a headline; at second second a short introduction paragraph
 and at third, the report generating directive. The second file shows how to integrate that document into the navigation
 bar.
@@ -117,7 +117,7 @@ bar.
 Directives
 **********
 
-.. rst:directive:: doc-coverage
+.. rst:directive:: report:doc-coverage
 
    Add a table summarizing the documentation coverage per Python source code file (packages and/or modules).
 
@@ -130,6 +130,18 @@ Directives
 
       Describes if and where to add a legend. Possible values: ``no_legend``, ``top``, ``bottom``, ``both``.
 
+.. rst:directive:: report:doc-coverage-legend
+
+   .. rst:directive:option:: style
+
+      Specifies the legend style. Default is ``horizontal-table``.
+
+      Possible values:
+
+      * ``default``
+      * ``horizontal-table``
+      * ``vertical-table``
+
 
 .. _DOCCOV/Roles:
 

diff --git a/doc/DocCoverage.rst b/doc/DocCoverage.rst
@@ -3,5 +3,12 @@ Documentation Coverage
 
 Documentation coverage generated by `docstr-coverage <https://github.com/HunterMcGushion/docstr_coverage>`__.
 
+.. report:doc-coverage-legend::
+   :packageid: src
+
 .. report:doc-coverage::
    :packageid: src
+
+.. report:doc-coverage-legend::
+   :packageid: src
+   :style: vertical-table
diff --git a/doc/Examples/Dependency.rst b/doc/Examples/Dependency.rst
@@ -0,0 +1,5 @@
+Dependency Trees
+################
+
+.. report:dependency-table::
+   :package: Sphinx
diff --git a/doc/Examples/Documentation.rst b/doc/Examples/Documentation.rst
@@ -0,0 +1,28 @@
+Documentation Coverage
+######################
+
+Undocumented
+************
+
+The following report shows an undocumented package.
+
+.. report:doc-coverage::
+   :packageid: undocumented
+
+
+Partially Documented
+********************
+
+The following report shows a partially documented package.
+
+.. report:doc-coverage::
+   :packageid: partially
+
+
+Fully Undocumented
+******************
+
+The following report shows a fully documented package.
+
+.. report:doc-coverage::
+   :packageid: documented
diff --git a/doc/Examples/FullyDocumented.rst b/doc/Examples/FullyDocumented.rst
diff --git a/doc/Examples/PartiallyDocumented.rst b/doc/Examples/PartiallyDocumented.rst
diff --git a/doc/Examples/Undocumented.rst b/doc/Examples/Undocumented.rst
diff --git a/doc/Installation.rst b/doc/Installation.rst
@@ -22,7 +22,7 @@ details.
 
 .. tab-set::
 
-   .. tab-item:: Linux/MacOS
+   .. tab-item:: Linux/macOS
       :sync: Linux
 
       .. code-block:: bash
@@ -43,7 +43,7 @@ just all (``all``) dependencies.
 
 .. tab-set::
 
-   .. tab-item:: Linux/MacOS
+   .. tab-item:: Linux/macOS
       :sync: Linux
 
       .. tab-set::
@@ -109,7 +109,7 @@ Updating from PyPI using PIP
 
 .. tab-set::
 
-   .. tab-item:: Linux/MacOS
+   .. tab-item:: Linux/macOS
       :sync: Linux
 
       .. code-block:: bash
@@ -131,7 +131,7 @@ Uninstallation using PIP
 
 .. tab-set::
 
-   .. tab-item:: Linux/MacOS
+   .. tab-item:: Linux/macOS
       :sync: Linux
 
       .. code-block:: bash
@@ -176,7 +176,7 @@ Ensure :ref:`packaging requirements <DEP/packaging>` are installed.
 
 .. tab-set::
 
-   .. tab-item:: Linux/MacOS
+   .. tab-item:: Linux/macOS
       :sync: Linux
 
       .. code-block:: bash

diff --git a/doc/Overview.rst b/doc/Overview.rst
@@ -23,18 +23,18 @@ See the following :file:`doc/requirements.txt` file as an example with commonly
    -r ../requirements.txt
 
    # Enforce latest version on ReadTheDocs
-   sphinx ~= 7
-   docutils ~= 0.18
+   sphinx ~= 8.1
+   docutils ~= 0.21
 
    # ReadTheDocs Theme
-   sphinx_rtd_theme ~= 2.0
+   sphinx_rtd_theme ~= 3.0
 
    # Sphinx Extenstions
    sphinxcontrib-mermaid ~= 0.9.2
    autoapi ~= 2.0.1
-   sphinx_design ~= 0.5.0
+   sphinx_design ~= 0.6.1
    sphinx-copybutton ~= 0.5.2
-   sphinx_autodoc_typehints ~= 1.25.2
+   sphinx_autodoc_typehints ~= 2.5
    sphinx_reports ~= 1.0
 
 Finally, the extension needs to be enabled in Sphinx's :file:`conf.py`, so the extension is loaded by Sphinx.

diff --git a/doc/Unittest/index.rst b/doc/Unittest/index.rst
@@ -6,11 +6,12 @@ Unit Test Summary
 🚧 This is a work-in-progress feature. 🚧
 
 .. #:term:`Unittests` checks if a source code was used during execution. Usually, testcases are run by a testcase
-execution framework like `pytest <https://github.com/pytest-dev/pytest>`__.
+   execution framework like `pytest <https://github.com/pytest-dev/pytest>`__.
 
 .. rubric:: Supported report generators
 
 * `pytest <https://github.com/pytest-dev/pytest>`__
+* `OSVVM-Scripts <https://github.com/OSVVM/OSVVM-Scripts>`__
 
 
 .. _UNITTEST/Quick:
@@ -44,7 +45,7 @@ See the :ref:`overview page <OVER>` on how to setup and enable the Sphinx extens
          }
       }
 
-2. Add the :rst:dir:`unittest-summary` directive into your Restructured Text (ReST) document.
+2. Add the :rst:dir:`report:unittest-summary` directive into your Restructured Text (ReST) document.
 
    .. code-block:: ReST
 
@@ -57,7 +58,7 @@ See the :ref:`overview page <OVER>` on how to setup and enable the Sphinx extens
 Example Document
 ****************
 
-The following ``unittest/index`` document is an example on how this documentation uses the :rst:dir:`unittest-summary`
+The following ``unittest/index`` document is an example on how this documentation uses the :rst:dir:`report:unittest-summary`
 directive. The first file consists of three parts: At first, a headline; at second second a short introduction paragraph
 and at third, the report generating directive. The second file shows how to integrate that document into the navigation
 bar.
@@ -98,7 +99,7 @@ bar.
 Directives
 **********
 
-.. rst:directive:: unittest-summary
+.. rst:directive:: report:unittest-summary
 
    Add a table summarizing the unittest results.
 
@@ -107,6 +108,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: