Skip to content

Commit 99b87a9

Browse files
PaebbelsPaebbels
authored
v0.29.1
2 parents 8ac0644 + e2c672f commit 99b87a9

File tree

11 files changed

+71
-70
lines changed

11 files changed

+71
-70
lines changed

‎.github/workflows/Pipeline.yml

Lines changed: 23 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ jobs:
1212
uses: pyTooling/Actions/.github/workflows/Parameters.yml@dev
1313
with:
1414
name: pyVHDLModel
15-
python_version_list: "3.9 3.10 3.11 3.12 pypy-3.9 pypy-3.10"
15+
# python_version_list: "3.9 3.10 3.11 3.12 pypy-3.9 pypy-3.10"
1616
# disable_list: "windows:pypy-3.8 windows:pypy-3.9 windows:pypy-3.10"
1717

1818
UnitTesting:
@@ -46,6 +46,11 @@ jobs:
4646
directory: pyVHDLModel
4747
# fail_below: 70
4848

49+
ConfigParams:
50+
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@dev
51+
needs:
52+
- DocCoverage
53+
4954
Package:
5055
uses: pyTooling/Actions/.github/workflows/Package.yml@dev
5156
needs:
@@ -76,43 +81,45 @@ jobs:
7681
with:
7782
merged_junit_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).unittesting_xml }}
7883

79-
IntermediateCleanUp:
80-
uses: pyTooling/Actions/.github/workflows/IntermediateCleanUp.yml@dev
81-
needs:
82-
- UnitTestingParams
83-
- PublishCoverageResults
84-
- PublishTestResults
85-
- HTMLDocumentation
86-
with:
87-
sqlite_coverage_artifacts_prefix: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_sqlite }}-
88-
xml_unittest_artifacts_prefix: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).unittesting_xml }}-
89-
9084
# VerifyDocs:
9185
# uses: pyTooling/Actions/.github/workflows/VerifyDocs.yml@dev
9286
# needs:
9387
# - UnitTestingParams
9488
# with:
9589
# python_version: ${{ needs.UnitTestingParams.outputs.python_version }}
9690

97-
HTMLDocumentation:
91+
Documentation:
9892
uses: pyTooling/Actions/.github/workflows/SphinxDocumentation.yml@dev
9993
needs:
10094
- UnitTestingParams
95+
- ConfigParams
10196
- PublishTestResults
10297
- PublishCoverageResults
10398
# - VerifyDocs
10499
with:
105100
python_version: ${{ needs.UnitTestingParams.outputs.python_version }}
101+
coverage_report_json_directory: ${{ needs.ConfigParams.outputs.coverage_report_json_directory }}
106102
unittest_xml_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).unittesting_xml }}-ubuntu-native-3.12
107103
coverage_json_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_json }}
108104
html_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_html }}
109105
latex_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_latex }}
110106

107+
IntermediateCleanUp:
108+
uses: pyTooling/Actions/.github/workflows/IntermediateCleanUp.yml@dev
109+
needs:
110+
- UnitTestingParams
111+
- PublishCoverageResults
112+
- PublishTestResults
113+
- Documentation
114+
with:
115+
sqlite_coverage_artifacts_prefix: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_sqlite }}-
116+
xml_unittest_artifacts_prefix: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).unittesting_xml }}-
117+
111118
# PDFDocumentation:
112119
# uses: pyTooling/Actions/.github/workflows/LaTeXDocumentation.yml@dev
113120
# needs:
114121
# - UnitTestingParams
115-
# - HTMLDocumentation
122+
# - Documentation
116123
# with:
117124
# document: pyVHDLModel
118125
# latex_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_latex }}
@@ -122,7 +129,7 @@ jobs:
122129
uses: pyTooling/Actions/.github/workflows/PublishToGitHubPages.yml@dev
123130
needs:
124131
- UnitTestingParams
125-
- HTMLDocumentation
132+
- Documentation
126133
# - PDFDocumentation
127134
- PublishCoverageResults
128135
- StaticTypeCheck
@@ -157,7 +164,7 @@ jobs:
157164
- UnitTestingParams
158165
- UnitTesting
159166
- StaticTypeCheck
160-
- HTMLDocumentation
167+
- Documentation
161168
# - PDFDocumentation
162169
- PublishTestResults
163170
- PublishCoverageResults

‎.idea/pyVHDLModel.iml

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎doc/Dependency.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ pyVHDLModel Package
2323
+--------------------------------------------------------+-------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
2424
| **Package** | **Version** | **License** | **Dependencies** |
2525
+========================================================+=============+==========================================================================================+=================================================================================================================================+
26-
| `pyTooling <https://GitHub.com/pyTooling/pyTooling>`__ | ≥6.6 | `Apache License, 2.0 <https://GitHub.com/pyTooling/pyTooling/blob/master/LICENSE.txt>`__ | *None* |
26+
| `pyTooling <https://GitHub.com/pyTooling/pyTooling>`__ | ≥7.0 | `Apache License, 2.0 <https://GitHub.com/pyTooling/pyTooling/blob/master/LICENSE.txt>`__ | *None* |
2727
+--------------------------------------------------------+-------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
2828

2929

@@ -53,11 +53,11 @@ the mandatory dependencies too.
5353
+=====================================================================+=============+========================================================================================+======================+
5454
| `pytest <https://GitHub.com/pytest-dev/pytest>`__ | ≥8.3 | `MIT <https://GitHub.com/pytest-dev/pytest/blob/master/LICENSE>`__ | *Not yet evaluated.* |
5555
+---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
56-
| `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.* |
56+
| `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.* |
5757
+---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
5858
| `Coverage <https://GitHub.com/nedbat/coveragepy>`__ | ≥7.6 | `Apache License, 2.0 <https://GitHub.com/nedbat/coveragepy/blob/master/LICENSE.txt>`__ | *Not yet evaluated.* |
5959
+---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
60-
| `mypy <https://GitHub.com/python/mypy>`__ | ≥1.11 | `MIT <https://GitHub.com/python/mypy/blob/master/LICENSE>`__ | *Not yet evaluated.* |
60+
| `mypy <https://GitHub.com/python/mypy>`__ | ≥1.13 | `MIT <https://GitHub.com/python/mypy/blob/master/LICENSE>`__ | *Not yet evaluated.* |
6161
+---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
6262
| `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.* |
6363
+---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
@@ -89,19 +89,19 @@ the mandatory dependencies too.
8989
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+----------------------+
9090
| **Package** | **Version** | **License** | **Dependencies** |
9191
+=================================================================================================+==============+==========================================================================================================+======================+
92-
| `pyTooling <https://GitHub.com/pyTooling/pyTooling>`__ | ≥6.6 | `Apache License, 2.0 <https://GitHub.com/pyTooling/pyTooling/blob/main/LICENSE.md>`__ | *None* |
92+
| `pyTooling <https://GitHub.com/pyTooling/pyTooling>`__ | ≥7.0 | `Apache License, 2.0 <https://GitHub.com/pyTooling/pyTooling/blob/main/LICENSE.md>`__ | *None* |
9393
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+----------------------+
94-
| `Sphinx <https://GitHub.com/sphinx-doc/sphinx>`__ | ≥7.4 | `BSD 3-Clause <https://GitHub.com/sphinx-doc/sphinx/blob/master/LICENSE>`__ | *Not yet evaluated.* |
94+
| `Sphinx <https://GitHub.com/sphinx-doc/sphinx>`__ | ≥8.1 | `BSD 3-Clause <https://GitHub.com/sphinx-doc/sphinx/blob/master/LICENSE>`__ | *Not yet evaluated.* |
9595
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+----------------------+
96-
| `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.* |
96+
| `sphinxcontrib-mermaid <https://GitHub.com/mgaitan/sphinxcontrib-mermaid>`__ | ≥1.0 | `BSD <https://GitHub.com/mgaitan/sphinxcontrib-mermaid/blob/master/LICENSE.rst>`__ | *Not yet evaluated.* |
9797
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+----------------------+
9898
| `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.* |
9999
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+----------------------+
100100
| `sphinx_btd_theme <https://GitHub.com/buildthedocs/sphinx.theme>`__ | | `MIT <https://GitHub.com/buildthedocs/sphinx.theme/blob/master/LICENSE>`__ | *Not yet evaluated.* |
101101
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+----------------------+
102102
| !! `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.* |
103103
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+----------------------+
104-
| `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.* |
104+
| `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.* |
105105
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+----------------------+
106106

107107

@@ -129,7 +129,7 @@ install the mandatory dependencies too.
129129
+----------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
130130
| **Package** | **Version** | **License** | **Dependencies** |
131131
+============================================================================+==============+==========================================================================================================+======================================================================================================================================================+
132-
| `pyTooling <https://GitHub.com/pyTooling/pyTooling>`__ | ≥6.6 | `Apache License, 2.0 <https://GitHub.com/pyTooling/pyTooling/blob/main/LICENSE.md>`__ | *None* |
132+
| `pyTooling <https://GitHub.com/pyTooling/pyTooling>`__ | ≥7.0 | `Apache License, 2.0 <https://GitHub.com/pyTooling/pyTooling/blob/main/LICENSE.md>`__ | *None* |
133133
+----------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
134134
| `wheel <https://GitHub.com/pypa/wheel>`__ | ≥0.44 | `MIT <https://github.com/pypa/wheel/blob/main/LICENSE.txt>`__ | *Not yet evaluated.* |
135135
+----------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+

‎doc/Installation.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ details.
2222

2323
.. tab-set::
2424

25-
.. tab-item:: Linux/MacOS
25+
.. tab-item:: Linux/macOS
2626
:sync: Linux
2727

2828
.. code-block:: bash
@@ -43,7 +43,7 @@ just all (``all``) dependencies.
4343

4444
.. tab-set::
4545

46-
.. tab-item:: Linux/MacOS
46+
.. tab-item:: Linux/macOS
4747
:sync: Linux
4848

4949
.. tab-set::
@@ -109,7 +109,7 @@ Updating from PyPI using PIP
109109

110110
.. tab-set::
111111

112-
.. tab-item:: Linux/MacOS
112+
.. tab-item:: Linux/macOS
113113
:sync: Linux
114114

115115
.. code-block:: bash
@@ -131,7 +131,7 @@ Uninstallation using PIP
131131

132132
.. tab-set::
133133

134-
.. tab-item:: Linux/MacOS
134+
.. tab-item:: Linux/macOS
135135
:sync: Linux
136136

137137
.. code-block:: bash
@@ -176,7 +176,7 @@ Ensure :ref:`packaging requirements <DEP/packaging>` are installed.
176176

177177
.. tab-set::
178178

179-
.. tab-item:: Linux/MacOS
179+
.. tab-item:: Linux/macOS
180180
:sync: Linux
181181

182182
.. code-block:: bash

‎doc/LanguageModel/index.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@
33
VHDL Language Model
44
###################
55

6-
.. rubric:: Design Goal
6+
.. rubric:: Design Goals
77

8-
* Clearly named classes that model the semantics of VHDL.
9-
* All language constructs (statements, declarations, specifications, …) have
10-
their own classes. |br| These classes are arranged in a logical hierarchy,
11-
with a single common base-class.
12-
* Child objects shall have a reference to their parent.
13-
* Comments will be associated with a particular code object.
14-
* Easy modifications of the object tree.
8+
* Clearly named classes that model the semantics of VHDL.
9+
* All language constructs (statements, declarations, specifications, …) have
10+
their own classes. |br| These classes are arranged in a logical hierarchy,
11+
with a single common base-class.
12+
* Child objects shall have a reference to their parent.
13+
* Comments will be associated with a particular code object.
14+
* Easy modifications of the object tree.
1515

1616
.. rubric:: Elements of the Language Model
1717

‎doc/conf.py

Lines changed: 10 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -272,40 +272,34 @@
272272
"publish": ["../dist/requirements.txt"],
273273
}
274274

275-
_coverageLevels = {
276-
30: {"class": "report-cov-below30", "desc": "almost undocumented"},
277-
50: {"class": "report-cov-below50", "desc": "poorly documented"},
278-
80: {"class": "report-cov-below80", "desc": "roughly documented"},
279-
90: {"class": "report-cov-below90", "desc": "well documented"},
280-
100: {"class": "report-cov-below100", "desc": "excellent documented"},
281-
"error": {"class": "report-cov-error", "desc": "internal error"},
282-
}
283-
284275
report_unittest_testsuites = {
285-
"src": {"xml_report": "../report/unit/TestReportSummary.xml"},
276+
"src": {
277+
"name": f"{project}",
278+
"xml_report": "../report/unit/TestReportSummary.xml",
279+
}
286280
}
287281
report_codecov_packages = {
288282
"src": {
289-
"name": "pyVHDLModel",
283+
"name": f"{project}",
290284
"json_report": "../report/coverage/coverage.json",
291285
"fail_below": 80,
292-
"levels": _coverageLevels
286+
"levels": "default"
293287
}
294288
}
295289
report_doccov_packages = {
296290
"src": {
297-
"name": "pyVHDLModel",
298-
"directory": "../pyVHDLModel",
291+
"name": f"{project}",
292+
"directory": f"../{project.replace('.', '/')}",
299293
"fail_below": 80,
300-
"levels": _coverageLevels
294+
"levels": "default"
301295
}
302296
}
303297

304298

305299
# ==============================================================================
306300
# Sphinx_Design
307301
# ==============================================================================
308-
sd_fontawesome_latex = True
302+
# sd_fontawesome_latex = True
309303

310304

311305
# ==============================================================================

0 commit comments

Comments
 (0)