Skip to content

v0.9.10 #71

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Paebbels wants to merge 4 commits into
base: main
Choose a base branch
from
Open

v0.9.10 #71

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
841a759
Bumped dependencies.
Paebbels Nov 20, 2025
d1c2435
Updated pyproject configuration to pytest v9.0
Paebbels Nov 20, 2025
0278cfa
Removed code specific to Python 3.9/3.10.
Paebbels Nov 20, 2025
581c781
Bumped dependencies. Allow Sphinx 9.x.
Paebbels Dec 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .github/workflows/Pipeline.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ jobs:
uses: pyTooling/Actions/.github/workflows/CompletePipeline.yml@r6
with:
package_name: 'sphinx_reports'
unittest_python_version: '3.13'
unittest_python_version_list: '3.11 3.12 3.13 3.14'
unittest_disable_list: 'windows-arm:* windows-arm:pypy-3.11'
bandit: 'true'
Expand Down
16 changes: 8 additions & 8 deletions doc/Dependency.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ When installed as ``pyTooling``:
+-----------------------------------------------------------------+-------------+-------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Package** | **Version** | **License** | **Dependencies** |
+=================================================================+=============+===========================================================================================+========================================================================================================================================================+
| `pyTooling <https://GitHub.com/pyTooling/pyTooling>`__ | ≥8.7 | `Apache License, 2.0 <https://GitHub.com/pyTooling/pyTooling/blob/main/LICENSE.txt>`__ | *None* |
| `pyTooling <https://GitHub.com/pyTooling/pyTooling>`__ | ≥8.8 | `Apache License, 2.0 <https://GitHub.com/pyTooling/pyTooling/blob/main/LICENSE.txt>`__ | *None* |
+-----------------------------------------------------------------+-------------+-------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+

.. TODO:: document the dependency to
Expand Down Expand Up @@ -102,13 +102,13 @@ the mandatory dependencies too.
+---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
| **Package** | **Version** | **License** | **Dependencies** |
+=====================================================================+=============+========================================================================================+======================+
| `pytest <https://GitHub.com/pytest-dev/pytest>`__ | ≥8.4 | `MIT <https://GitHub.com/pytest-dev/pytest/blob/master/LICENSE>`__ | *Not yet evaluated.* |
| `pytest <https://GitHub.com/pytest-dev/pytest>`__ | ≥9.0 | `MIT <https://GitHub.com/pytest-dev/pytest/blob/master/LICENSE>`__ | *Not yet evaluated.* |
+---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
| `pytest-cov <https://GitHub.com/pytest-dev/pytest-cov>`__ | ≥7.0 | `MIT <https://GitHub.com/pytest-dev/pytest-cov/blob/master/LICENSE>`__ | *Not yet evaluated.* |
+---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
| `Coverage <https://GitHub.com/nedbat/coveragepy>`__ | ≥7.11 | `Apache License, 2.0 <https://GitHub.com/nedbat/coveragepy/blob/master/LICENSE.txt>`__ | *Not yet evaluated.* |
| `Coverage <https://GitHub.com/nedbat/coveragepy>`__ | ≥7.12 | `Apache License, 2.0 <https://GitHub.com/nedbat/coveragepy/blob/master/LICENSE.txt>`__ | *Not yet evaluated.* |
+---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
| `mypy <https://GitHub.com/python/mypy>`__ | ≥1.18 | `MIT <https://GitHub.com/python/mypy/blob/master/LICENSE>`__ | *Not yet evaluated.* |
| `mypy <https://GitHub.com/python/mypy>`__ | ≥1.19 | `MIT <https://GitHub.com/python/mypy/blob/master/LICENSE>`__ | *Not yet evaluated.* |
+---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
| `typing-extensions <https://GitHub.com/python/typing_extensions>`__ | ≥4.15 | `PSF-2.0 <https://github.com/python/typing_extensions/blob/main/LICENSE>`__ | *Not yet evaluated.* |
+---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
Expand Down Expand Up @@ -152,11 +152,11 @@ the mandatory dependencies too.
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Package** | **Version** | **License** | **Dependencies** |
+=================================================================================================+==============+==========================================================================================================+======================================================================================================================================================+
| `pyTooling <https://GitHub.com/pyTooling/pyTooling>`__ | ≥8.7 | `Apache License, 2.0 <https://GitHub.com/pyTooling/pyTooling/blob/main/LICENSE.md>`__ | *None* |
| `pyTooling <https://GitHub.com/pyTooling/pyTooling>`__ | ≥8.8 | `Apache License, 2.0 <https://GitHub.com/pyTooling/pyTooling/blob/main/LICENSE.md>`__ | *None* |
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| `Sphinx <https://GitHub.com/sphinx-doc/sphinx>`__ | ≥8.2 | `BSD 3-Clause <https://GitHub.com/sphinx-doc/sphinx/blob/master/LICENSE>`__ | *Not yet evaluated.* |
| `Sphinx <https://GitHub.com/sphinx-doc/sphinx>`__ | ≥9.0 | `BSD 3-Clause <https://GitHub.com/sphinx-doc/sphinx/blob/master/LICENSE>`__ | *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.* |
| `sphinxcontrib-mermaid <https://GitHub.com/mgaitan/sphinxcontrib-mermaid>`__ | ≥1.2 | `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.* |
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
Expand Down Expand Up @@ -213,7 +213,7 @@ install the mandatory dependencies too.
+----------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Package** | **Version** | **License** | **Dependencies** |
+============================================================================+==============+==========================================================================================================+======================================================================================================================================================+
| `pyTooling <https://GitHub.com/pyTooling/pyTooling>`__ | ≥8.7 | `Apache License, 2.0 <https://GitHub.com/pyTooling/pyTooling/blob/main/LICENSE.md>`__ | *None* |
| `pyTooling <https://GitHub.com/pyTooling/pyTooling>`__ | ≥8.8 | `Apache License, 2.0 <https://GitHub.com/pyTooling/pyTooling/blob/main/LICENSE.md>`__ | *None* |
+----------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| `wheel <https://GitHub.com/pypa/wheel>`__ | ≥0.45 | `MIT <https://github.com/pypa/wheel/blob/main/LICENSE.txt>`__ | *Not yet evaluated.* |
+----------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
Expand Down
6 changes: 3 additions & 3 deletions doc/Overview.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,14 +37,14 @@ See the following :file:`doc/requirements.txt` file as an example with commonly
-r ../requirements.txt

# Enforce latest version on ReadTheDocs
sphinx ~= 8.2
docutils ~= 0.21
sphinx ~= 9.0
docutils ~= 0.22

# ReadTheDocs Theme
sphinx_rtd_theme ~= 3.0

# Sphinx Extenstions
sphinxcontrib-mermaid ~= 1.0
sphinxcontrib-mermaid ~= 1.2
autoapi ~= 2.0.1
sphinx_design ~= 0.6
sphinx-copybutton ~= 0.5
Expand Down
6 changes: 3 additions & 3 deletions doc/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
-r ../requirements.txt

# Enforce latest version on ReadTheDocs
sphinx ~= 8.2
docutils ~= 0.21
sphinx >= 8.0, < 10.0
docutils ~= 0.22
docutils_stubs ~= 0.0.22

# ReadTheDocs Theme
sphinx_rtd_theme ~= 3.0

# Sphinx Extenstions
sphinxcontrib-mermaid ~= 1.0
sphinxcontrib-mermaid ~= 1.2
autoapi ~= 2.0.1
sphinx_design ~= 0.6
sphinx-copybutton ~= 0.5
Expand Down
18 changes: 8 additions & 10 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
requires = [
"setuptools >= 80.0",
"wheel ~= 0.45",
"pyTooling ~= 8.7"
"pyTooling ~= 8.8"
]
build-backend = "setuptools.build_meta"

Expand All @@ -21,23 +21,21 @@ namespace_packages = true
html_report = "report/typing"

[tool.pytest]
junit_xml = "report/unit/UnittestReportSummary.xml"

[tool.pyedaa-reports]
junit_xml = "report/unit/unittest.xml"

[tool.pytest.ini_options]
addopts = "--tb=native"
addopts = ["--tb=native"]
# Don't set 'python_classes = *' otherwise, pytest doesn't search for classes
# derived from unittest.Testcase
python_files = "*"
python_functions = "test_*"
python_files = ["*"]
python_functions = ["test_*"]
filterwarnings = [
"error::DeprecationWarning",
"error::PendingDeprecationWarning"
]
junit_xml = "report/unit/UnittestReportSummary.xml"
junit_logging = "all"

[tool.pyedaa-reports]
junit_xml = "report/unit/unittest.xml"

[tool.interrogate]
color = true
verbose = 1 # possible values: 0 (minimal output), 1 (-v), 2 (-vv)
Expand Down
6 changes: 3 additions & 3 deletions requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
pyTooling >= 6.7, <9.0
pyEDAA.Reports ~= 0.17

sphinx ~= 8.2
docutils ~= 0.21
sphinx >= 8.0, < 10.0
docutils >= 0.21, < 0.23
docutils_stubs ~= 0.0.22

Coverage ~= 7.11
Coverage ~= 7.12
docstr_coverage ~= 2.3.2
2 changes: 1 addition & 1 deletion run.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Param(
)

$PackageName = "sphinx_reports"
$PackageVersion = "0.9.9"
$PackageVersion = "0.9.10"

# set default values
$EnableDebug = [bool]$PSCmdlet.MyInvocation.BoundParameters["Debug"]
Expand Down
11 changes: 1 addition & 10 deletions sphinx_reports/Common.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@
**Common exceptions, classes and helper functions.**
"""
from enum import Flag
from sys import version_info
from typing import List

from pyTooling.Decorators import export
Expand All @@ -41,15 +40,7 @@

@export
class ReportExtensionError(ExtensionError):
# WORKAROUND: for Python <3.11
# Implementing a dummy method for Python versions before
__notes__: List[str]
if version_info < (3, 11): # pragma: no cover
def add_note(self, message: str) -> None:
try:
self.__notes__.append(message)
except AttributeError:
self.__notes__ = [message]
pass


@export
Expand Down
4 changes: 2 additions & 2 deletions sphinx_reports/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
__email__ = "[email protected]"
__copyright__ = "2023-2025, Patrick Lehmann"
__license__ = "Apache License, Version 2.0"
__version__ = "0.9.9"
__version__ = "0.9.10"
__keywords__ = [
"Python3", "Sphinx", "Extension", "Report", "doc-string", "interrogate", "Code Coverage", "Coverage",
"Documentation Coverage", "Unittest", "Dependencies", "Summary"
Expand Down Expand Up @@ -215,7 +215,7 @@ def AddCSSFiles(sphinxApplication: Sphinx) -> None:
cssContent = readResourceFile(ResourcePackage, cssFilename)

# Compute md5 hash of CSS file
hash = md5(cssContent.encode("utf8")).hexdigest()
hash = md5(cssContent.encode("utf8")).hexdigest() # nosec B324

# Write the CSS file into output directory
cssFile = staticDirectory / f"sphinx-reports.{hash}.css"
Expand Down
10 changes: 5 additions & 5 deletions tests/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
-r ../requirements.txt

# Coverage collection
Coverage ~= 7.11
Coverage ~= 7.12

# Test Runner
pytest ~= 8.4
pytest ~= 9.0
pytest-cov ~= 7.0

# Static Type Checking
mypy[reports] ~= 1.18
typing_extensions ~= 4.15
lxml >= 5.4, <7.0
mypy[reports] ~= 1.19; sys_platform != 'win32'
typing_extensions ~= 4.15; sys_platform != 'win32'
lxml >= 5.4, <7.0; sys_platform != 'win32'
Loading