v0.29.1

VHDL · Nov 3, 2024 · 99b87a9 · 99b87a9
2 parents 8ac0644 + e2c672f
commit 99b87a9
Show file tree

Hide file tree

Showing 11 changed files with 71 additions and 70 deletions.
diff --git a/.github/workflows/Pipeline.yml b/.github/workflows/Pipeline.yml
@@ -12,7 +12,7 @@ jobs:
     uses: pyTooling/Actions/.github/workflows/Parameters.yml@dev
     with:
       name: pyVHDLModel
-      python_version_list: "3.9 3.10 3.11 3.12 pypy-3.9 pypy-3.10"
+#      python_version_list: "3.9 3.10 3.11 3.12 pypy-3.9 pypy-3.10"
 #      disable_list: "windows:pypy-3.8 windows:pypy-3.9 windows:pypy-3.10"
 
   UnitTesting:
@@ -46,6 +46,11 @@ jobs:
       directory: pyVHDLModel
 #      fail_below: 70
 
+  ConfigParams:
+    uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@dev
+    needs:
+      - DocCoverage
+
   Package:
     uses: pyTooling/Actions/.github/workflows/Package.yml@dev
     needs:
@@ -76,43 +81,45 @@ jobs:
     with:
       merged_junit_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).unittesting_xml }}
 
-  IntermediateCleanUp:
-    uses: pyTooling/Actions/.github/workflows/IntermediateCleanUp.yml@dev
-    needs:
-      - UnitTestingParams
-      - PublishCoverageResults
-      - PublishTestResults
-      - HTMLDocumentation
-    with:
-      sqlite_coverage_artifacts_prefix: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_sqlite }}-
-      xml_unittest_artifacts_prefix: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).unittesting_xml }}-
-
 #  VerifyDocs:
 #    uses: pyTooling/Actions/.github/workflows/VerifyDocs.yml@dev
 #    needs:
 #      - UnitTestingParams
 #    with:
 #      python_version: ${{ needs.UnitTestingParams.outputs.python_version }}
 
-  HTMLDocumentation:
+  Documentation:
     uses: pyTooling/Actions/.github/workflows/SphinxDocumentation.yml@dev
     needs:
       - UnitTestingParams
+      - ConfigParams
       - PublishTestResults
       - PublishCoverageResults
 #      - VerifyDocs
     with:
       python_version: ${{ needs.UnitTestingParams.outputs.python_version }}
+      coverage_report_json_directory: ${{ needs.ConfigParams.outputs.coverage_report_json_directory }}
       unittest_xml_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).unittesting_xml }}-ubuntu-native-3.12
       coverage_json_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_json }}
       html_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_html }}
       latex_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_latex }}
 
+  IntermediateCleanUp:
+    uses: pyTooling/Actions/.github/workflows/IntermediateCleanUp.yml@dev
+    needs:
+      - UnitTestingParams
+      - PublishCoverageResults
+      - PublishTestResults
+      - Documentation
+    with:
+      sqlite_coverage_artifacts_prefix: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_sqlite }}-
+      xml_unittest_artifacts_prefix: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).unittesting_xml }}-
+
 #  PDFDocumentation:
 #    uses: pyTooling/Actions/.github/workflows/LaTeXDocumentation.yml@dev
 #    needs:
 #      - UnitTestingParams
-#      - HTMLDocumentation
+#      - Documentation
 #    with:
 #      document: pyVHDLModel
 #      latex_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_latex }}
@@ -122,7 +129,7 @@ jobs:
     uses: pyTooling/Actions/.github/workflows/PublishToGitHubPages.yml@dev
     needs:
       - UnitTestingParams
-      - HTMLDocumentation
+      - Documentation
 #      - PDFDocumentation
       - PublishCoverageResults
       - StaticTypeCheck
@@ -157,7 +164,7 @@ jobs:
       - UnitTestingParams
       - UnitTesting
       - StaticTypeCheck
-      - HTMLDocumentation
+      - Documentation
 #      - PDFDocumentation
       - PublishTestResults
       - PublishCoverageResults

diff --git a/.idea/pyVHDLModel.iml b/.idea/pyVHDLModel.iml
diff --git a/doc/Dependency.rst b/doc/Dependency.rst
@@ -23,7 +23,7 @@ pyVHDLModel Package
 +--------------------------------------------------------+-------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
 | **Package**                                            | **Version** | **License**                                                                              | **Dependencies**                                                                                                                |
 +========================================================+=============+==========================================================================================+=================================================================================================================================+
-| `pyTooling <https://GitHub.com/pyTooling/pyTooling>`__ | ≥6.6        | `Apache License, 2.0 <https://GitHub.com/pyTooling/pyTooling/blob/master/LICENSE.txt>`__ | *None*                                                                                                                          |
+| `pyTooling <https://GitHub.com/pyTooling/pyTooling>`__ | ≥7.0        | `Apache License, 2.0 <https://GitHub.com/pyTooling/pyTooling/blob/master/LICENSE.txt>`__ | *None*                                                                                                                          |
 +--------------------------------------------------------+-------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
 
 
@@ -53,11 +53,11 @@ the mandatory dependencies too.
 +=====================================================================+=============+========================================================================================+======================+
 | `pytest <https://GitHub.com/pytest-dev/pytest>`__                   | ≥8.3        | `MIT <https://GitHub.com/pytest-dev/pytest/blob/master/LICENSE>`__                     | *Not yet evaluated.* |
 +---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
-| `pytest-cov <https://GitHub.com/pytest-dev/pytest-cov>`__           | ≥5.0        | `MIT <https://GitHub.com/pytest-dev/pytest-cov/blob/master/LICENSE>`__                 | *Not yet evaluated.* |
+| `pytest-cov <https://GitHub.com/pytest-dev/pytest-cov>`__           | ≥6.0        | `MIT <https://GitHub.com/pytest-dev/pytest-cov/blob/master/LICENSE>`__                 | *Not yet evaluated.* |
 +---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
 | `Coverage <https://GitHub.com/nedbat/coveragepy>`__                 | ≥7.6        | `Apache License, 2.0 <https://GitHub.com/nedbat/coveragepy/blob/master/LICENSE.txt>`__ | *Not yet evaluated.* |
 +---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
-| `mypy <https://GitHub.com/python/mypy>`__                           | ≥1.11       | `MIT <https://GitHub.com/python/mypy/blob/master/LICENSE>`__                           | *Not yet evaluated.* |
+| `mypy <https://GitHub.com/python/mypy>`__                           | ≥1.13       | `MIT <https://GitHub.com/python/mypy/blob/master/LICENSE>`__                           | *Not yet evaluated.* |
 +---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
 | `typing-extensions <https://GitHub.com/python/typing_extensions>`__ | ≥4.12       | `PSF-2.0 <https://github.com/python/typing_extensions/blob/main/LICENSE>`__            | *Not yet evaluated.* |
 +---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
@@ -89,19 +89,19 @@ the mandatory dependencies too.
 +-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+----------------------+
 | **Package**                                                                                     | **Version**  | **License**                                                                                              | **Dependencies**     |
 +=================================================================================================+==============+==========================================================================================================+======================+
-| `pyTooling <https://GitHub.com/pyTooling/pyTooling>`__                                          | ≥6.6         | `Apache License, 2.0 <https://GitHub.com/pyTooling/pyTooling/blob/main/LICENSE.md>`__                    | *None*               |
+| `pyTooling <https://GitHub.com/pyTooling/pyTooling>`__                                          | ≥7.0         | `Apache License, 2.0 <https://GitHub.com/pyTooling/pyTooling/blob/main/LICENSE.md>`__                    | *None*               |
 +-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+----------------------+
-| `Sphinx <https://GitHub.com/sphinx-doc/sphinx>`__                                               | ≥7.4         | `BSD 3-Clause <https://GitHub.com/sphinx-doc/sphinx/blob/master/LICENSE>`__                              | *Not yet evaluated.* |
+| `Sphinx <https://GitHub.com/sphinx-doc/sphinx>`__                                               | ≥8.1         | `BSD 3-Clause <https://GitHub.com/sphinx-doc/sphinx/blob/master/LICENSE>`__                              | *Not yet evaluated.* |
 +-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+----------------------+
-| `sphinxcontrib-mermaid <https://GitHub.com/mgaitan/sphinxcontrib-mermaid>`__                    | ≥0.9.2       | `BSD <https://GitHub.com/mgaitan/sphinxcontrib-mermaid/blob/master/LICENSE.rst>`__                       | *Not yet evaluated.* |
+| `sphinxcontrib-mermaid <https://GitHub.com/mgaitan/sphinxcontrib-mermaid>`__                    | ≥1.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_btd_theme <https://GitHub.com/buildthedocs/sphinx.theme>`__                             |              | `MIT <https://GitHub.com/buildthedocs/sphinx.theme/blob/master/LICENSE>`__                               | *Not yet evaluated.* |
 +-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+----------------------+
 | !! `sphinx_fontawesome <https://GitHub.com/fraoustin/sphinx_fontawesome>`__                     | ≥0.0.6       | `GPL 2.0 <https://GitHub.com/fraoustin/sphinx_fontawesome/blob/master/LICENSE>`__                        | *Not yet evaluated.* |
 +-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+----------------------+
-| `sphinx_autodoc_typehints <https://GitHub.com/agronholm/sphinx-autodoc-typehints>`__            | ≥2.3         | `MIT <https://GitHub.com/agronholm/sphinx-autodoc-typehints/blob/master/LICENSE>`__                      | *Not yet evaluated.* |
+| `sphinx_autodoc_typehints <https://GitHub.com/agronholm/sphinx-autodoc-typehints>`__            | ≥2.5         | `MIT <https://GitHub.com/agronholm/sphinx-autodoc-typehints/blob/master/LICENSE>`__                      | *Not yet evaluated.* |
 +-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+----------------------+
 
 
@@ -129,7 +129,7 @@ install the mandatory dependencies too.
 +----------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
 | **Package**                                                                | **Version**  | **License**                                                                                              | **Dependencies**                                                                                                                                     |
 +============================================================================+==============+==========================================================================================================+======================================================================================================================================================+
-| `pyTooling <https://GitHub.com/pyTooling/pyTooling>`__                     | ≥6.6         | `Apache License, 2.0 <https://GitHub.com/pyTooling/pyTooling/blob/main/LICENSE.md>`__                    | *None*                                                                                                                                               |
+| `pyTooling <https://GitHub.com/pyTooling/pyTooling>`__                     | ≥7.0         | `Apache License, 2.0 <https://GitHub.com/pyTooling/pyTooling/blob/main/LICENSE.md>`__                    | *None*                                                                                                                                               |
 +----------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
 | `wheel <https://GitHub.com/pypa/wheel>`__                                  | ≥0.44        | `MIT <https://github.com/pypa/wheel/blob/main/LICENSE.txt>`__                                            | *Not yet evaluated.*                                                                                                                                 |
 +----------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+

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/LanguageModel/index.rst b/doc/LanguageModel/index.rst
@@ -3,15 +3,15 @@
 VHDL Language Model
 ###################
 
-.. rubric:: Design Goal
+.. rubric:: Design Goals
 
-   * Clearly named classes that model the semantics of VHDL.
-   * All language constructs (statements, declarations, specifications, …) have
-     their own classes. |br| These classes are arranged in a logical hierarchy,
-     with a single common base-class.
-   * Child objects shall have a reference to their parent.
-   * Comments will be associated with a particular code object.
-   * Easy modifications of the object tree.
+* Clearly named classes that model the semantics of VHDL.
+* All language constructs (statements, declarations, specifications, …) have
+  their own classes. |br| These classes are arranged in a logical hierarchy,
+  with a single common base-class.
+* Child objects shall have a reference to their parent.
+* Comments will be associated with a particular code object.
+* Easy modifications of the object tree.
 
 .. rubric:: Elements of the Language Model
 

diff --git a/doc/conf.py b/doc/conf.py
@@ -272,40 +272,34 @@
 	"publish": ["../dist/requirements.txt"],
 }
 
-_coverageLevels = {
-	30:      {"class": "report-cov-below30",  "desc": "almost undocumented"},
-	50:      {"class": "report-cov-below50",  "desc": "poorly documented"},
-	80:      {"class": "report-cov-below80",  "desc": "roughly documented"},
-	90:      {"class": "report-cov-below90",  "desc": "well documented"},
-	100:     {"class": "report-cov-below100", "desc": "excellent documented"},
-	"error": {"class": "report-cov-error",    "desc": "internal error"},
-}
-
 report_unittest_testsuites = {
-	"src":   {"xml_report": "../report/unit/TestReportSummary.xml"},
+	"src": {
+		"name":        f"{project}",
+		"xml_report":  "../report/unit/TestReportSummary.xml",
+	}
 }
 report_codecov_packages = {
 	"src": {
-		"name":        "pyVHDLModel",
+		"name":        f"{project}",
 		"json_report": "../report/coverage/coverage.json",
 		"fail_below":  80,
-		"levels":      _coverageLevels
+		"levels":      "default"
 	}
 }
 report_doccov_packages = {
 	"src": {
-		"name":       "pyVHDLModel",
-		"directory":  "../pyVHDLModel",
+		"name":       f"{project}",
+		"directory":  f"../{project.replace('.', '/')}",
 		"fail_below": 80,
-		"levels":     _coverageLevels
+		"levels":     "default"
 	}
 }
 
 
 # ==============================================================================
 # Sphinx_Design
 # ==============================================================================
-sd_fontawesome_latex = True
+# sd_fontawesome_latex = True
 
 
 # ==============================================================================