diff --git a/.github/workflows/Pipeline.yml b/.github/workflows/Pipeline.yml
index a8dbad35..12abc2a2 100644
--- a/.github/workflows/Pipeline.yml
+++ b/.github/workflows/Pipeline.yml
@@ -9,10 +9,10 @@ on:
jobs:
UnitTestingParams:
- uses: pyTooling/Actions/.github/workflows/Parameters.yml@r1
+ uses: pyTooling/Actions/.github/workflows/Parameters.yml@dev
with:
name: sphinx-reports
- python_version_list: "3.10 3.11 3.12 pypy-3.10"
+ python_version_list: "3.10 3.11 3.12 3.13 pypy-3.10"
# disable_list: "windows:pypy-3.8 windows:pypy-3.9 windows:pypy-3.10"
UnitTesting:
@@ -27,7 +27,7 @@ jobs:
coverage_sqlite_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_sqlite }}
StaticTypeCheck:
- uses: pyTooling/Actions/.github/workflows/StaticTypeCheck.yml@r1
+ uses: pyTooling/Actions/.github/workflows/StaticTypeCheck.yml@dev
needs:
- UnitTestingParams
with:
@@ -38,7 +38,7 @@ jobs:
html_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).statictyping_html }}
DocCoverage:
- uses: pyTooling/Actions/.github/workflows/CheckDocumentation.yml@r1
+ uses: pyTooling/Actions/.github/workflows/CheckDocumentation.yml@dev
needs:
- UnitTestingParams
with:
@@ -46,8 +46,13 @@ jobs:
directory: sphinx_reports
# fail_below: 70
+ ConfigParams:
+ uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@dev
+ needs:
+ - DocCoverage
+
Package:
- uses: pyTooling/Actions/.github/workflows/Package.yml@r1
+ uses: pyTooling/Actions/.github/workflows/Package.yml@dev
needs:
- UnitTestingParams
- UnitTesting
@@ -56,7 +61,7 @@ jobs:
artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).package_all }}
PublishCoverageResults:
- uses: pyTooling/Actions/.github/workflows/PublishCoverageResults.yml@r1
+ uses: pyTooling/Actions/.github/workflows/PublishCoverageResults.yml@dev
needs:
- UnitTestingParams
- UnitTesting
@@ -69,60 +74,62 @@ jobs:
codacy_token: ${{ secrets.CODACY_PROJECT_TOKEN }}
PublishTestResults:
- uses: pyTooling/Actions/.github/workflows/PublishTestResults.yml@r1
+ uses: pyTooling/Actions/.github/workflows/PublishTestResults.yml@dev
needs:
- UnitTestingParams
- UnitTesting
with:
merged_junit_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).unittesting_xml }}
- IntermediateCleanUp:
- uses: pyTooling/Actions/.github/workflows/IntermediateCleanUp.yml@r1
- 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@r1
+# uses: pyTooling/Actions/.github/workflows/VerifyDocs.yml@dev
# needs:
# - UnitTestingParams
# with:
# python_version: ${{ needs.UnitTestingParams.outputs.python_version }}
- HTMLDocumentation:
- uses: pyTooling/Actions/.github/workflows/SphinxDocumentation.yml@r1
+ 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@r1
+ uses: pyTooling/Actions/.github/workflows/LaTeXDocumentation.yml@dev
needs:
- UnitTestingParams
- - HTMLDocumentation
+ - Documentation
with:
document: sphinx_reports
latex_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_latex }}
pdf_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_pdf }}
PublishToGitHubPages:
- uses: pyTooling/Actions/.github/workflows/PublishToGitHubPages.yml@r1
+ uses: pyTooling/Actions/.github/workflows/PublishToGitHubPages.yml@dev
needs:
- UnitTestingParams
- - HTMLDocumentation
+ - Documentation
# - PDFDocumentation
- PublishCoverageResults
- StaticTypeCheck
@@ -132,14 +139,14 @@ jobs:
typing: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).statictyping_html }}
ReleasePage:
- uses: pyTooling/Actions/.github/workflows/Release.yml@r1
+ uses: pyTooling/Actions/.github/workflows/Release.yml@dev
if: startsWith(github.ref, 'refs/tags')
needs:
- Package
- PublishToGitHubPages
PublishOnPyPI:
- uses: pyTooling/Actions/.github/workflows/PublishOnPyPI.yml@r1
+ uses: pyTooling/Actions/.github/workflows/PublishOnPyPI.yml@dev
if: startsWith(github.ref, 'refs/tags')
needs:
- UnitTestingParams
@@ -152,12 +159,12 @@ jobs:
PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
ArtifactCleanUp:
- uses: pyTooling/Actions/.github/workflows/ArtifactCleanUp.yml@r1
+ uses: pyTooling/Actions/.github/workflows/ArtifactCleanUp.yml@dev
needs:
- UnitTestingParams
- UnitTesting
- StaticTypeCheck
- - HTMLDocumentation
+ - Documentation
- PDFDocumentation
- PublishTestResults
- PublishCoverageResults
diff --git a/.idea/sphinx-reports.iml b/.idea/sphinx-reports.iml
index 05a55ab9..a3801d28 100644
--- a/.idea/sphinx-reports.iml
+++ b/.idea/sphinx-reports.iml
@@ -10,7 +10,8 @@
-
+
+
\ No newline at end of file
diff --git a/doc/Dependency.rst b/doc/Dependency.rst
index 9abaa35b..52299a02 100644
--- a/doc/Dependency.rst
+++ b/doc/Dependency.rst
@@ -53,7 +53,7 @@ When installed as ``pyTooling``:
+-----------------------------------------------------------------+-------------+-------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Package** | **Version** | **License** | **Dependencies** |
+=================================================================+=============+===========================================================================================+========================================================================================================================================================+
-| `pyTooling `__ | ≥6.7 | `Apache License, 2.0 `__ | *None* |
+| `pyTooling `__ | ≥7.0 | `Apache License, 2.0 `__ | *None* |
+-----------------------------------------------------------------+-------------+-------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
.. TODO:: document the dependency to
@@ -61,6 +61,7 @@ When installed as ``pyTooling``:
* Sphinx
* docstr_coverage
* interrogate
+ * pyEDAA.Reports
.. _DEP/testing:
@@ -103,11 +104,11 @@ the mandatory dependencies too.
+=====================================================================+=============+========================================================================================+======================+
| `pytest `__ | ≥8.3 | `MIT `__ | *Not yet evaluated.* |
+---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
-| `pytest-cov `__ | ≥5.0.0 | `MIT `__ | *Not yet evaluated.* |
+| `pytest-cov `__ | ≥6.0 | `MIT `__ | *Not yet evaluated.* |
+---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
| `Coverage `__ | ≥7.6 | `Apache License, 2.0 `__ | *Not yet evaluated.* |
+---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
-| `mypy `__ | ≥1.11 | `MIT `__ | *Not yet evaluated.* |
+| `mypy `__ | ≥1.13 | `MIT `__ | *Not yet evaluated.* |
+---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
| `typing-extensions `__ | ≥4.12 | `PSF-2.0 `__ | *Not yet evaluated.* |
+---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
@@ -151,7 +152,7 @@ the mandatory dependencies too.
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Package** | **Version** | **License** | **Dependencies** |
+=================================================================================================+==============+==========================================================================================================+======================================================================================================================================================+
-| `pyTooling `__ | ≥6.7 | `Apache License, 2.0 `__ | *None* |
+| `pyTooling `__ | ≥7.0 | `Apache License, 2.0 `__ | *None* |
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| `Sphinx `__ | ≥8.1 | `BSD 3-Clause `__ | *Not yet evaluated.* |
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -212,7 +213,7 @@ install the mandatory dependencies too.
+----------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Package** | **Version** | **License** | **Dependencies** |
+============================================================================+==============+==========================================================================================================+======================================================================================================================================================+
-| `pyTooling `__ | ≥6.7 | `Apache License, 2.0 `__ | *None* |
+| `pyTooling `__ | ≥7.0 | `Apache License, 2.0 `__ | *None* |
+----------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| `wheel `__ | ≥0.44 | `MIT `__ | *Not yet evaluated.* |
+----------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
diff --git a/doc/requirements.txt b/doc/requirements.txt
index 8bfaa985..c7b347d7 100644
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@@ -1,10 +1,5 @@
-r ../requirements.txt
-# XXX: because of missing dependency in pyTooling
-setuptools ~= 75.1
-
-pyTooling ~= 6.7
-
# Enforce latest version on ReadTheDocs
sphinx ~= 8.1
docutils ~= 0.21
diff --git a/pyproject.toml b/pyproject.toml
index b1d21c5b..69af2b3a 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -1,8 +1,8 @@
[build-system]
requires = [
- "setuptools ~= 75.1",
+ "setuptools ~= 75.3",
"wheel ~= 0.44",
- "pyTooling ~= 6.7"
+ "pyTooling ~= 7.0"
]
build-backend = "setuptools.build_meta"
diff --git a/requirements.txt b/requirements.txt
index 9fd574e6..86b1eb66 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -1,8 +1,9 @@
-pyTooling ~= 6.7
-pyEDAA.Reports ~= 0.13
+pyTooling >= 6.7, <8.0
+pyEDAA.Reports ~= 0.14
sphinx ~= 8.0
docutils ~= 0.21
+docutils_stubs ~= 0.0.22
Coverage ~= 7.6
docstr_coverage ~= 2.3.2
diff --git a/sphinx_reports/Common.py b/sphinx_reports/Common.py
index 3dc536fb..608c0b4b 100644
--- a/sphinx_reports/Common.py
+++ b/sphinx_reports/Common.py
@@ -32,10 +32,8 @@
**Common exceptions, classes and helper functions.**
"""
from enum import Flag
-from importlib.resources import files
from sys import version_info
-from types import ModuleType
-from typing import List, Union
+from typing import List
from pyTooling.Decorators import export
from sphinx.errors import ExtensionError
diff --git a/sphinx_reports/__init__.py b/sphinx_reports/__init__.py
index 6ad2ff87..94f3d5de 100644
--- a/sphinx_reports/__init__.py
+++ b/sphinx_reports/__init__.py
@@ -43,7 +43,7 @@
__email__ = "Paebbels@gmail.com"
__copyright__ = "2023-2024, Patrick Lehmann"
__license__ = "Apache License, Version 2.0"
-__version__ = "0.7.2"
+__version__ = "0.7.3"
__keywords__ = ["Python3", "Sphinx", "Extension", "Report", "doc-string", "interrogate"]
from hashlib import md5
diff --git a/tests/requirements.txt b/tests/requirements.txt
index 77e2f22b..2ad659b6 100644
--- a/tests/requirements.txt
+++ b/tests/requirements.txt
@@ -5,9 +5,9 @@ Coverage ~= 7.6
# Test Runner
pytest ~= 8.3
-pytest-cov ~= 5.0
+pytest-cov ~= 6.0
# Static Type Checking
-mypy ~= 1.11
+mypy ~= 1.13
typing_extensions ~= 4.12
lxml ~= 5.3