Skip to content

Commit 2b4af3b

Browse files
PaebbelsPaebbels
authored
v0.31.1
2 parents 5724f86 + 65346d8 commit 2b4af3b

File tree

14 files changed

+427
-51
lines changed

14 files changed

+427
-51
lines changed

‎.github/workflows/Pipeline.yml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@ jobs:
1212
uses: pyTooling/Actions/.github/workflows/CompletePipeline.yml@r4
1313
with:
1414
package_name: pyVHDLModel
15+
codecov: true
16+
codacy: true
17+
dorny: true
1518
secrets:
1619
PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
20+
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
1721
CODACY_PROJECT_TOKEN: ${{ secrets.CODACY_PROJECT_TOKEN }}

‎.idea/pyVHDLModel.iml‎

Lines changed: 2 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎doc/CodeCoverage.rst‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
.. _CODECOV:
2+
3+
Code Coverage Report
4+
####################
5+
6+
.. grid:: 2
7+
8+
.. grid-item::
9+
:columns: 8
10+
11+
.. report:code-coverage::
12+
:reportid: src
13+
14+
.. grid-item::
15+
:columns: 4
16+
17+
.. report:code-coverage-legend::
18+
:reportid: src
19+
:style: vertical-table
20+
21+
----------
22+
23+
Code coverage report generated with `pytest <https://github.com/pytest-dev/pytest>`__,
24+
`Coverage.py <https://github.com/nedbat/coveragepy/tree/master>`__ and visualized by
25+
`sphinx-reports <https://github.com/pyTooling/sphinx-reports>`__.

‎doc/Dependency.rst‎

Lines changed: 6 additions & 6 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>`__ | ≥8.2 | `Apache License, 2.0 <https://GitHub.com/pyTooling/pyTooling/blob/master/LICENSE.txt>`__ | *None* |
26+
| `pyTooling <https://GitHub.com/pyTooling/pyTooling>`__ | ≥8.4 | `Apache License, 2.0 <https://GitHub.com/pyTooling/pyTooling/blob/master/LICENSE.txt>`__ | *None* |
2727
+--------------------------------------------------------+-------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
2828

2929

@@ -53,13 +53,13 @@ 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>`__ | ≥6.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.1 | `MIT <https://GitHub.com/pytest-dev/pytest-cov/blob/master/LICENSE>`__ | *Not yet evaluated.* |
5757
+---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
58-
| `Coverage <https://GitHub.com/nedbat/coveragepy>`__ | ≥7.6 | `Apache License, 2.0 <https://GitHub.com/nedbat/coveragepy/blob/master/LICENSE.txt>`__ | *Not yet evaluated.* |
58+
| `Coverage <https://GitHub.com/nedbat/coveragepy>`__ | ≥7.8 | `Apache License, 2.0 <https://GitHub.com/nedbat/coveragepy/blob/master/LICENSE.txt>`__ | *Not yet evaluated.* |
5959
+---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
6060
| `mypy <https://GitHub.com/python/mypy>`__ | ≥1.15 | `MIT <https://GitHub.com/python/mypy/blob/master/LICENSE>`__ | *Not yet evaluated.* |
6161
+---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
62-
| `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.* |
62+
| `typing-extensions <https://GitHub.com/python/typing_extensions>`__ | ≥4.13 | `PSF-2.0 <https://github.com/python/typing_extensions/blob/main/LICENSE>`__ | *Not yet evaluated.* |
6363
+---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
6464
| `lxml <https://GitHub.com/lxml/lxml>`__ | ≥5.3 | `BSD 3-Clause <https://GitHub.com/lxml/lxml/blob/master/LICENSE.txt>`__ | *Not yet evaluated.* |
6565
+---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
@@ -89,7 +89,7 @@ the mandatory dependencies too.
8989
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+----------------------+
9090
| **Package** | **Version** | **License** | **Dependencies** |
9191
+=================================================================================================+==============+==========================================================================================================+======================+
92-
| `pyTooling <https://GitHub.com/pyTooling/pyTooling>`__ | ≥8.2 | `Apache License, 2.0 <https://GitHub.com/pyTooling/pyTooling/blob/main/LICENSE.md>`__ | *None* |
92+
| `pyTooling <https://GitHub.com/pyTooling/pyTooling>`__ | ≥8.4 | `Apache License, 2.0 <https://GitHub.com/pyTooling/pyTooling/blob/main/LICENSE.md>`__ | *None* |
9393
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+----------------------+
9494
| `Sphinx <https://GitHub.com/sphinx-doc/sphinx>`__ | ≥8.2 | `BSD 3-Clause <https://GitHub.com/sphinx-doc/sphinx/blob/master/LICENSE>`__ | *Not yet evaluated.* |
9595
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+----------------------+
@@ -129,7 +129,7 @@ install the mandatory dependencies too.
129129
+----------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
130130
| **Package** | **Version** | **License** | **Dependencies** |
131131
+============================================================================+==============+==========================================================================================================+======================================================================================================================================================+
132-
| `pyTooling <https://GitHub.com/pyTooling/pyTooling>`__ | ≥8.2 | `Apache License, 2.0 <https://GitHub.com/pyTooling/pyTooling/blob/main/LICENSE.md>`__ | *None* |
132+
| `pyTooling <https://GitHub.com/pyTooling/pyTooling>`__ | ≥8.4 | `Apache License, 2.0 <https://GitHub.com/pyTooling/pyTooling/blob/main/LICENSE.md>`__ | *None* |
133133
+----------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
134134
| `wheel <https://GitHub.com/pypa/wheel>`__ | ≥0.45 | `MIT <https://github.com/pypa/wheel/blob/main/LICENSE.txt>`__ | *Not yet evaluated.* |
135135
+----------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+

‎doc/DocCoverage.rst‎

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,24 @@
1-
Documentation Coverage
2-
######################
1+
.. _DOCCOV:
32

4-
Documentation coverage generated by `docstr-coverage <https://github.com/HunterMcGushion/docstr_coverage>`__.
3+
Documentation Coverage Report
4+
#############################
55

6-
.. report:doc-coverage::
7-
:packageid: src
6+
.. grid:: 2
7+
8+
.. grid-item::
9+
:columns: 5
10+
11+
.. report:doc-coverage::
12+
:reportid: src
13+
14+
.. grid-item::
15+
:columns: 7
16+
17+
.. report:doc-coverage-legend::
18+
:reportid: src
19+
:style: vertical-table
20+
21+
----------
22+
23+
Documentation coverage generated with `"""docstr-coverage""" <https://github.com/HunterMcGushion/docstr_coverage>`__ and
24+
visualized by `sphinx-reports <https://github.com/pyTooling/sphinx-reports>`__.

‎doc/conf.py‎

Lines changed: 26 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,29 @@
11
# If extensions (or modules to document with autodoc) are in another directory,
22
# add these directories to sys.path here. If the directory is relative to the
33
# documentation root, use os.path.abspath to make it absolute, like shown here.
4-
from importlib.util import find_spec
54
from sys import path as sys_path
65
from os.path import abspath
76
from pathlib import Path
87
from json import loads
98

109
from pyTooling.Packaging import extractVersionInformation
1110

11+
# ==============================================================================
12+
# Project configuration
13+
# ==============================================================================
14+
githubNamespace = "VHDL"
15+
project = "pyVHDLModel"
16+
directoryName = project.replace('.', '/')
17+
18+
19+
# ==============================================================================
20+
# Project paths
21+
# ==============================================================================
1222
ROOT = Path(__file__).resolve().parent
1323

1424
sys_path.insert(0, abspath("."))
1525
sys_path.insert(0, abspath(".."))
16-
sys_path.insert(0, abspath("../pyVHDLModel"))
17-
# sys_path.insert(0, abspath("_extensions"))
26+
sys_path.insert(0, abspath(f"../{directoryName}"))
1827

1928

2029
# ==============================================================================
@@ -23,8 +32,6 @@
2332
# The version info for the project you're documenting, acts as replacement for
2433
# |version| and |release|, also used in various other places throughout the
2534
# built documents.
26-
project = "pyVHDLModel"
27-
2835
packageInformationFile = Path(f"../{project.replace('.', '/')}/__init__.py")
2936
versionInformation = extractVersionInformation(packageInformationFile)
3037

@@ -100,7 +107,7 @@
100107
html_favicon = str(Path(html_static_path[0]) / "favicon.svg")
101108

102109
# Output file base name for HTML help builder.
103-
htmlhelp_basename = "pyVHDLModelDoc"
110+
htmlhelp_basename = f"{project}Doc"
104111

105112
# If not None, a 'Last updated on:' timestamp is inserted at every page
106113
# bottom, using the given strftime format.
@@ -153,10 +160,10 @@
153160
# author, documentclass [howto, manual, or own class]).
154161
latex_documents = [
155162
( master_doc,
156-
"pyVHDLModel.tex",
157-
"The pyVHDLModel Documentation",
158-
"Patrick Lehmann",
159-
"manual"
163+
f"{project}.tex",
164+
f"The {project} Documentation",
165+
f"Patrick Lehmann",
166+
f"manual"
160167
),
161168
]
162169

@@ -192,8 +199,8 @@
192199
# ==============================================================================
193200
intersphinx_mapping = {
194201
"python": ("https://docs.python.org/3", None),
195-
"vasg": ("https://IEEE-P1076.gitlab.io/", None),
196202
"pyTool": ("https://pyTooling.github.io/pyTooling/", None),
203+
"vasg": ("https://IEEE-P1076.gitlab.io/", None),
197204
"ghdl": ("https://GHDL.github.io/ghdl/", None),
198205
}
199206

@@ -218,11 +225,12 @@
218225
# Sphinx.Ext.ExtLinks
219226
# ==============================================================================
220227
extlinks = {
221-
"gh": ("https://GitHub.com/%s", "gh:%s"),
222-
"ghissue": ("https://GitHub.com/VHDL/pyVHDLModel/issues/%s", "issue #%s"),
223-
"ghpull": ("https://GitHub.com/VHDL/pyVHDLModel/pull/%s", "pull request #%s"),
224-
"ghsrc": ("https://GitHub.com/VHDL/pyVHDLModel/blob/main/%s", None),
225-
"wiki": ("https://en.wikipedia.org/wiki/%s", None),
228+
"gh": (f"https://GitHub.com/%s", "%s"),
229+
"ghissue": (f"https://GitHub.com/{githubNamespace}/{project}/issues/%s", "issue #%s"),
230+
"ghpull": (f"https://GitHub.com/{githubNamespace}/{project}/pull/%s", "pull request #%s"),
231+
"ghsrc": (f"https://GitHub.com/{githubNamespace}/{project}/blob/main/%s", None),
232+
"pypi": ("https://PyPI.org/project/%s", "%s"),
233+
"wiki": (f"https://en.wikipedia.org/wiki/%s", None),
226234
}
227235

228236

@@ -275,7 +283,7 @@
275283
report_unittest_testsuites = {
276284
"src": {
277285
"name": f"{project}",
278-
"xml_report": "../report/unit/TestReportSummary.xml",
286+
"xml_report": "../report/unit/unittest.xml",
279287
}
280288
}
281289
report_codecov_packages = {
@@ -289,7 +297,7 @@
289297
report_doccov_packages = {
290298
"src": {
291299
"name": f"{project}",
292-
"directory": f"../{project.replace('.', '/')}",
300+
"directory": f"../{directoryName}",
293301
"fail_below": 80,
294302
"levels": "default"
295303
}

‎doc/coverage/index.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
Code Coverage Report
2-
####################
1+
Code Coverage Details
2+
#####################
33

44
Code coverage report generated with `pytest <https://github.com/pytest-dev/pytest>`__ and `Coverage.py <https://github.com/nedbat/coveragepy/tree/master>`__.
55

66
.. report:code-coverage::
7-
:packageid: src
7+
:reportid: src

‎doc/index.rst‎

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ The pyVHDLModel Documentation
3535
An abstract VHDL language model.
3636

3737

38-
.. _goals:
38+
.. _GOALS:
3939

4040
Main Goals
4141
**********
@@ -49,7 +49,7 @@ build higher level features and services on such a model, while supporting multi
4949
frontends.
5050

5151

52-
.. _usecase:
52+
.. _USECASES:
5353

5454
Use Cases
5555
*********
@@ -58,7 +58,7 @@ Use Cases
5858
* Code Document-Object-Model (Code-DOM) in `pyVHDLParser <https://paebbels.github.io/pyVHDLParser/>`__.
5959

6060

61-
.. _news:
61+
.. _NEWS:
6262

6363
News
6464
****
@@ -174,8 +174,8 @@ News
174174
Contributors
175175
************
176176

177-
* `Patrick Lehmann <https://GitHub.com/Paebbels>`__ (Maintainer)
178-
* `Unai Martinez-Corral <https://GitHub.com/umarcor/>`__
177+
* :gh:`Patrick Lehmann <Paebbels>` (Maintainer)
178+
* :gh:`Unai Martinez-Corral <umarcor>`
179179
* `and more... <https://GitHub.com/VHDL/pyVHDLModel/graphs/contributors>`__
180180

181181

@@ -195,10 +195,6 @@ License
195195
The accompanying documentation is licensed under **Creative Commons - Attribution 4.0 (CC-BY 4.0)**.
196196

197197

198-
.. only:: html
199-
200-
This document was generated on |docdate|.
201-
202198

203199
.. toctree::
204200
:hidden:
@@ -227,7 +223,6 @@ License
227223
Analyze/index
228224
DataStructure/index
229225

230-
231226
.. raw:: latex
232227

233228
\part{References and Reports}
@@ -239,6 +234,7 @@ License
239234
Python Class Reference <pyVHDLModel/pyVHDLModel>
240235
unittests/index
241236
coverage/index
237+
CodeCoverage
242238
Doc. Coverage Report <DocCoverage>
243239
Static Type Check Report ➚ <typing/index>
244240

‎doc/requirements.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,4 @@ autoapi >= 2.0.1
1414
sphinx_design ~= 0.6.1
1515
sphinx-copybutton >= 0.5.2
1616
sphinx_autodoc_typehints ~= 3.1
17-
sphinx_reports ~= 0.7
17+
sphinx_reports ~= 0.9

‎pyVHDLModel/__init__.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@
4848
__email__ = "[email protected]"
4949
__copyright__ = "2016-2025, Patrick Lehmann"
5050
__license__ = "Apache License, Version 2.0"
51-
__version__ = "0.31.0"
51+
__version__ = "0.31.1"
5252

5353

5454
from enum import unique, Enum, Flag, auto

0 commit comments

Comments
 (0)