Skip to content

v0.10.0 #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

Merged
Paebbels merged 8 commits into from
Jan 20, 2026
Merged

v0.10.0 #71

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 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
6212701
Bumped dependencies.
Paebbels Jan 20, 2026
ac34000
Bumped version information.
Paebbels Jan 20, 2026
45b7236
Added missing type hints.
Paebbels Jan 20, 2026
2033190
Dependency fine tuning.
Paebbels Jan 20, 2026
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
3 changes: 1 addition & 2 deletions .github/workflows/Pipeline.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,9 @@ on:

jobs:
Pipeline:
uses: pyTooling/Actions/.github/workflows/CompletePipeline.yml@r6
uses: pyTooling/Actions/.github/workflows/CompletePipeline.yml@r7
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
4 changes: 2 additions & 2 deletions .idea/sphinx-reports.iml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion dist/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
wheel ~= 0.45
wheel ~= 0.45.0
twine ~= 6.2
22 changes: 11 additions & 11 deletions doc/Dependency.rst
View file
Open in desktop

Large diffs are not rendered by default.

14 changes: 7 additions & 7 deletions doc/Overview.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,18 +37,18 @@ 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.1
docutils ~= 0.22

# ReadTheDocs Theme
sphinx_rtd_theme ~= 3.0
sphinx_rtd_theme ~= 3.1

# Sphinx Extenstions
sphinxcontrib-mermaid ~= 1.0
sphinxcontrib-mermaid ~= 2.0
autoapi ~= 2.0.1
sphinx_design ~= 0.6
sphinx-copybutton ~= 0.5
sphinx_autodoc_typehints ~= 3.5
sphinx_design ~= 0.7.0
sphinx-copybutton ~= 0.5.0
sphinx_autodoc_typehints ~= 3.6
sphinx_reports ~= 1.0 # <= new entry

Finally, the extension needs to be enabled in Sphinx's :file:`conf.py`, so the extension is loaded by Sphinx.
Expand Down
16 changes: 8 additions & 8 deletions doc/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
-r ../requirements.txt

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

# ReadTheDocs Theme
sphinx_rtd_theme ~= 3.0
sphinx_rtd_theme ~= 3.1

# Sphinx Extenstions
sphinxcontrib-mermaid ~= 1.0
sphinxcontrib-mermaid ~= 2.0
autoapi ~= 2.0.1
sphinx_design ~= 0.6
sphinx-copybutton ~= 0.5
sphinx_autodoc_typehints ~= 3.5
sphinx_design ~= 0.7.0
sphinx-copybutton ~= 0.5.0
sphinx_autodoc_typehints ~= 3.6
20 changes: 9 additions & 11 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
[build-system]
requires = [
"setuptools >= 80.0",
"wheel ~= 0.45",
"pyTooling ~= 8.7"
"wheel ~= 0.45.0",
"pyTooling ~= 8.11"
]
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
13 changes: 6 additions & 7 deletions requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
pyTooling >= 6.7, <9.0
pyEDAA.Reports ~= 0.17
pyTooling >= 8.0
pyEDAA.Reports ~= 0.17.0
sphinx >= 9.0, < 10.0
docutils >= 0.22.0
docutils_stubs >= 0.0.22

sphinx ~= 8.2
docutils ~= 0.21
docutils_stubs ~= 0.0.22

Coverage ~= 7.11
Coverage ~= 7.13
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
2 changes: 1 addition & 1 deletion setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
# #
# License: #
# ==================================================================================================================== #
# Copyright 2023-2025 Patrick Lehmann - Bötzingen, Germany #
# Copyright 2023-2026 Patrick Lehmann - Bötzingen, Germany #
# #
# Licensed under the Apache License, Version 2.0 (the "License"); #
# you may not use this file except in compliance with the License. #
Expand Down
2 changes: 1 addition & 1 deletion sphinx_reports/Adapter/Coverage.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
# #
# License: #
# ==================================================================================================================== #
# Copyright 2023-2025 Patrick Lehmann - Bötzingen, Germany #
# Copyright 2023-2026 Patrick Lehmann - Bötzingen, Germany #
# #
# Licensed under the Apache License, Version 2.0 (the "License"); #
# you may not use this file except in compliance with the License. #
Expand Down
2 changes: 1 addition & 1 deletion sphinx_reports/Adapter/Dependency.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
class DependencyScanner:
_distribution: Distribution

def __init__(self, distributionName: str):
def __init__(self, distributionName: str) -> None:
md1 = importlib_metadata(distributionName)

self._distribution = Distribution(distributionName)
Expand Down
2 changes: 1 addition & 1 deletion sphinx_reports/Adapter/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
# #
# License: #
# ==================================================================================================================== #
# Copyright 2023-2025 Patrick Lehmann - Bötzingen, Germany #
# Copyright 2023-2026 Patrick Lehmann - Bötzingen, Germany #
# #
# Licensed under the Apache License, Version 2.0 (the "License"); #
# you may not use this file except in compliance with the License. #
Expand Down
2 changes: 1 addition & 1 deletion sphinx_reports/CodeCoverage.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
# #
# License: #
# ==================================================================================================================== #
# Copyright 2023-2025 Patrick Lehmann - Bötzingen, Germany #
# Copyright 2023-2026 Patrick Lehmann - Bötzingen, Germany #
# #
# Licensed under the Apache License, Version 2.0 (the "License"); #
# you may not use this file except in compliance with the License. #
Expand Down
13 changes: 2 additions & 11 deletions sphinx_reports/Common.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
# #
# License: #
# ==================================================================================================================== #
# Copyright 2023-2025 Patrick Lehmann - Bötzingen, Germany #
# Copyright 2023-2026 Patrick Lehmann - Bötzingen, Germany #
# #
# Licensed under the Apache License, Version 2.0 (the "License"); #
# you may not use this file except in compliance with the License. #
Expand All @@ -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
2 changes: 1 addition & 1 deletion sphinx_reports/DataModel/CodeCoverage.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
# #
# License: #
# ==================================================================================================================== #
# Copyright 2023-2025 Patrick Lehmann - Bötzingen, Germany #
# Copyright 2023-2026 Patrick Lehmann - Bötzingen, Germany #
# #
# Licensed under the Apache License, Version 2.0 (the "License"); #
# you may not use this file except in compliance with the License. #
Expand Down
8 changes: 4 additions & 4 deletions sphinx_reports/DataModel/Dependency.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
# #
# License: #
# ==================================================================================================================== #
# Copyright 2023-2025 Patrick Lehmann - Bötzingen, Germany #
# Copyright 2023-2026 Patrick Lehmann - Bötzingen, Germany #
# #
# Licensed under the Apache License, Version 2.0 (the "License"); #
# you may not use this file except in compliance with the License. #
Expand All @@ -38,15 +38,15 @@
class VersionSpecifier:
_spec: str

def __init__(self, spec: str):
def __init__(self, spec: str) -> None:
self._spec = spec


@export
class License:
_name: str

def __init__(self, name: str):
def __init__(self, name: str) -> None:
self._name = name


Expand All @@ -58,7 +58,7 @@ class Distribution:
_licenses: List[License]
_dependencies: List["Distribution"]

def __init__(self, name: str):
def __init__(self, name: str) -> None:
self._name = name

self._packages = []
Expand Down
2 changes: 1 addition & 1 deletion sphinx_reports/DataModel/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
# #
# License: #
# ==================================================================================================================== #
# Copyright 2023-2025 Patrick Lehmann - Bötzingen, Germany #
# Copyright 2023-2026 Patrick Lehmann - Bötzingen, Germany #
# #
# Licensed under the Apache License, Version 2.0 (the "License"); #
# you may not use this file except in compliance with the License. #
Expand Down
2 changes: 1 addition & 1 deletion sphinx_reports/Dependency.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
# #
# License: #
# ==================================================================================================================== #
# Copyright 2023-2025 Patrick Lehmann - Bötzingen, Germany #
# Copyright 2023-2026 Patrick Lehmann - Bötzingen, Germany #
# #
# Licensed under the Apache License, Version 2.0 (the "License"); #
# you may not use this file except in compliance with the License. #
Expand Down
2 changes: 1 addition & 1 deletion sphinx_reports/DocCoverage.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
# #
# License: #
# ==================================================================================================================== #
# Copyright 2023-2025 Patrick Lehmann - Bötzingen, Germany #
# Copyright 2023-2026 Patrick Lehmann - Bötzingen, Germany #
# #
# Licensed under the Apache License, Version 2.0 (the "License"); #
# you may not use this file except in compliance with the License. #
Expand Down
2 changes: 1 addition & 1 deletion sphinx_reports/Sphinx.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
# #
# License: #
# ==================================================================================================================== #
# Copyright 2023-2025 Patrick Lehmann - Bötzingen, Germany #
# Copyright 2023-2026 Patrick Lehmann - Bötzingen, Germany #
# #
# Licensed under the Apache License, Version 2.0 (the "License"); #
# you may not use this file except in compliance with the License. #
Expand Down
4 changes: 2 additions & 2 deletions sphinx_reports/Unittest.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
# #
# License: #
# ==================================================================================================================== #
# Copyright 2023-2025 Patrick Lehmann - Bötzingen, Germany #
# Copyright 2023-2026 Patrick Lehmann - Bötzingen, Germany #
# #
# Licensed under the Apache License, Version 2.0 (the "License"); #
# you may not use this file except in compliance with the License. #
Expand Down Expand Up @@ -64,7 +64,7 @@ class ShowTestcases(Flag):
all = passed | failed | skipped | excluded | errors | aborted
not_passed = all & ~passed

def __eq__(self, other):
def __eq__(self, other: Any) -> bool:
if isinstance(other, TestcaseStatus):
if other is TestcaseStatus.Passed:
return ShowTestcases.passed in self
Expand Down
8 changes: 4 additions & 4 deletions sphinx_reports/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
# #
# License: #
# ==================================================================================================================== #
# Copyright 2023-2025 Patrick Lehmann - Bötzingen, Germany #
# Copyright 2023-2026 Patrick Lehmann - Bötzingen, Germany #
# #
# Licensed under the Apache License, Version 2.0 (the "License"); #
# you may not use this file except in compliance with the License. #
Expand Down Expand Up @@ -41,9 +41,9 @@
"""
__author__ = "Patrick Lehmann"
__email__ = "Paebbels@gmail.com"
__copyright__ = "2023-2025, Patrick Lehmann"
__copyright__ = "2023-2026, Patrick Lehmann"
__license__ = "Apache License, Version 2.0"
__version__ = "0.9.9"
__version__ = "0.10.0"
__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
Loading
Loading