Updating r5 from main@v5.0.0.

This commit is contained in:
Patrick Lehmann
2025-06-17 09:03:56 +02:00
47 changed files with 1727 additions and 295 deletions

View File

@@ -55,8 +55,7 @@ Simple Example
uses: pyTooling/Actions/.github/workflows/CoverageCollection.yml@r4
with:
artifact: Coverage
secrets:
codacy_token: ${{ secrets.CODACY_PROJECT_TOKEN }}
secrets: inherit
Complex Example
===============
@@ -71,8 +70,7 @@ Complex Example
with:
python_version: ${{ needs.Params.outputs.python_version }}
artifact: ${{ fromJson(needs.Params.outputs.artifact_names).codecoverage_html }}
secrets:
codacy_token: ${{ secrets.CODACY_PROJECT_TOKEN }}
secrets: inherit
Parameters
**********

View File

@@ -1,20 +1,29 @@
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
from importlib.util import find_spec
from sys import path as sys_path
from os.path import abspath
from pathlib import Path
from json import loads
from pyTooling.Packaging import extractVersionInformation
# ==============================================================================
# Project configuration
# ==============================================================================
githubNamespace = "pyTooling"
githubProject = "Actions"
pythonProject = "pyDummy"
directoryName = pythonProject.replace('.', '/')
# ==============================================================================
# Project paths
# ==============================================================================
ROOT = Path(__file__).resolve().parent
sys_path.insert(0, abspath("."))
sys_path.insert(0, abspath(".."))
sys_path.insert(0, abspath("../pyDummy"))
# sys_path.insert(0, abspath("_extensions"))
sys_path.insert(0, abspath(f"../{directoryName}"))
# ==============================================================================
@@ -23,11 +32,7 @@ sys_path.insert(0, abspath("../pyDummy"))
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
githubNamespace = "pyTooling"
githubProject = "Actions"
project = "pyDummy"
packageInformationFile = Path(f"../{project}/__init__.py")
packageInformationFile = Path(f"../{directoryName}/__init__.py")
versionInformation = extractVersionInformation(packageInformationFile)
author = versionInformation.Author
@@ -105,7 +110,7 @@ html_last_updated_fmt = "%d.%m.%Y"
# Python settings
# ==============================================================================
modindex_common_prefix = [
f"{project}."
f"{pythonProject}."
]
# ==============================================================================
@@ -257,13 +262,13 @@ todo_link_only = True
# ==============================================================================
# report_unittest_testsuites = {
# "src": {
# "name": f"{project}",
# "name": f"{pythonProject}",
# "xml_report": "../report/unit/unittest.xml",
# }
# }
# report_codecov_packages = {
# "src": {
# "name": f"{project}",
# "name": f"{pythonProject}",
# "json_report": "../report/coverage/coverage.json",
# "fail_below": 80,
# "levels": "default"
@@ -271,8 +276,8 @@ todo_link_only = True
# }
# report_doccov_packages = {
# "src": {
# "name": f"{project}",
# "directory": f"../{project}",
# "name": f"{pythonProject}",
# "directory": f"../{directoryName}",
# "fail_below": 80,
# "levels": "default"
# }
@@ -289,17 +294,17 @@ todo_link_only = True
# AutoAPI.Sphinx
# ==============================================================================
autoapi_modules = {
f"{project}": {
f"{pythonProject}": {
"template": "package",
"output": project,
"output": pythonProject,
"override": True
}
}
for directory in [mod for mod in Path(f"../{project}").iterdir() if mod.is_dir() and mod.name != "__pycache__"]:
print(f"Adding module rule for '{project}.{directory.name}'")
autoapi_modules[f"{project}.{directory.name}"] = {
for directory in [mod for mod in Path(f"../{directoryName}").iterdir() if mod.is_dir() and mod.name != "__pycache__"]:
print(f"Adding module rule for '{pythonProject}.{directory.name}'")
autoapi_modules[f"{pythonProject}.{directory.name}"] = {
"template": "module",
"output": project,
"output": pythonProject,
"override": True
}

View File

@@ -4,4 +4,4 @@ Code Coverage Report
Code coverage report generated with `pytest <https://github.com/pytest-dev/pytest>`__ and `Coverage.py <https://github.com/nedbat/coveragepy/tree/master>`__.
.. #report:code-coverage::
:packageid: src
:reportid: src

View File

@@ -5,7 +5,7 @@ pushd %~dp0
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
set SPHINXBUILD=py -3.13 -m sphinx.cmd.build
)
set SOURCEDIR=.
set BUILDDIR=_build

View File

@@ -1,6 +1,6 @@
-r ../requirements.txt
pyTooling ~= 8.4
pyTooling ~= 8.5
# Enforce latest version on ReadTheDocs
sphinx ~= 8.2
@@ -15,5 +15,5 @@ sphinxcontrib-mermaid ~= 1.0
autoapi >= 2.0.1
sphinx_design ~= 0.6.1
sphinx-copybutton >= 0.5.2
sphinx_autodoc_typehints ~= 3.1
sphinx_reports ~= 0.7
sphinx_autodoc_typehints ~= 3.2
sphinx_reports ~= 0.9