From a3587b17df55af19f3534f7a8e844817c4b3ad69 Mon Sep 17 00:00:00 2001 From: Patrick Lehmann Date: Mon, 9 Dec 2024 22:01:59 +0100 Subject: [PATCH] Bumped dependencies. --- .github/workflows/Pipeline.yml | 5 +++-- .gitignore | 10 +++++++--- doc/CodeCov/index.rst | 2 +- doc/Dependency.rst | 8 ++++---- doc/DocCov/index.rst | 2 +- doc/Installation.rst | 6 ++++-- doc/Overview.rst | 2 +- doc/Unittest/index.rst | 2 +- doc/conf.py | 2 +- doc/requirements.txt | 9 +-------- pyproject.toml | 4 ++-- 11 files changed, 26 insertions(+), 26 deletions(-) diff --git a/.github/workflows/Pipeline.yml b/.github/workflows/Pipeline.yml index 12abc2a2..a583c408 100644 --- a/.github/workflows/Pipeline.yml +++ b/.github/workflows/Pipeline.yml @@ -40,10 +40,11 @@ jobs: DocCoverage: uses: pyTooling/Actions/.github/workflows/CheckDocumentation.yml@dev needs: + - ConfigParams - UnitTestingParams with: python_version: ${{ needs.UnitTestingParams.outputs.python_version }} - directory: sphinx_reports + directory: ${{ needs.ConfigParams.outputs.package_directors }} # fail_below: 70 ConfigParams: @@ -91,8 +92,8 @@ jobs: Documentation: uses: pyTooling/Actions/.github/workflows/SphinxDocumentation.yml@dev needs: - - UnitTestingParams - ConfigParams + - UnitTestingParams - PublishTestResults - PublishCoverageResults # - VerifyDocs diff --git a/.gitignore b/.gitignore index af3e2100..6d93f49d 100644 --- a/.gitignore +++ b/.gitignore @@ -6,9 +6,13 @@ __pycache__/ .coverage .cov coverage.xml +/report/coverage -# Generated reports -report/ +# mypy +/report/typing + +# pytest +/report/unit # setuptools /build/**/*.* @@ -26,7 +30,7 @@ doc/sphinx_reports/**/*.* # BuildTheDocs doc/_theme/**/*.* -# IntelliJ project files +# PyCharm project files /.idea/workspace.xml # Git files diff --git a/doc/CodeCov/index.rst b/doc/CodeCov/index.rst index 1f680903..258f4ea8 100644 --- a/doc/CodeCov/index.rst +++ b/doc/CodeCov/index.rst @@ -93,7 +93,7 @@ bar. :caption: References and Reports :hidden: - sphinx_reports/sphinx_reports + Python Class Reference unittests/index coverage/index Doc. Coverage Report diff --git a/doc/Dependency.rst b/doc/Dependency.rst index 1177c6d7..468b92af 100644 --- a/doc/Dependency.rst +++ b/doc/Dependency.rst @@ -53,7 +53,7 @@ When installed as ``pyTooling``: +-----------------------------------------------------------------+-------------+-------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | **Package** | **Version** | **License** | **Dependencies** | +=================================================================+=============+===========================================================================================+========================================================================================================================================================+ -| `pyTooling `__ | ≥7.0 | `Apache License, 2.0 `__ | *None* | +| `pyTooling `__ | ≥8.0 | `Apache License, 2.0 `__ | *None* | +-----------------------------------------------------------------+-------------+-------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ .. TODO:: document the dependency to @@ -152,11 +152,11 @@ the mandatory dependencies too. +-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | **Package** | **Version** | **License** | **Dependencies** | +=================================================================================================+==============+==========================================================================================================+======================================================================================================================================================+ -| `pyTooling `__ | ≥7.0 | `Apache License, 2.0 `__ | *None* | +| `pyTooling `__ | ≥8.0 | `Apache License, 2.0 `__ | *None* | +-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | `Sphinx `__ | ≥8.1 | `BSD 3-Clause `__ | *Not yet evaluated.* | +-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| `sphinxcontrib-mermaid `__ | ≥0.9.2 | `BSD `__ | *Not yet evaluated.* | +| `sphinxcontrib-mermaid `__ | ≥1.0 | `BSD `__ | *Not yet evaluated.* | +-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | `autoapi `__ | ≥2.0.1 | `Apache License, 2.0 `__ | *Not yet evaluated.* | +-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -213,7 +213,7 @@ install the mandatory dependencies too. +----------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | **Package** | **Version** | **License** | **Dependencies** | +============================================================================+==============+==========================================================================================================+======================================================================================================================================================+ -| `pyTooling `__ | ≥7.0 | `Apache License, 2.0 `__ | *None* | +| `pyTooling `__ | ≥8.0 | `Apache License, 2.0 `__ | *None* | +----------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | `wheel `__ | ≥0.45 | `MIT `__ | *Not yet evaluated.* | +----------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/doc/DocCov/index.rst b/doc/DocCov/index.rst index bb3945f6..4c56efee 100644 --- a/doc/DocCov/index.rst +++ b/doc/DocCov/index.rst @@ -101,7 +101,7 @@ bar. :caption: References and Reports :hidden: - sphinx_reports/sphinx_reports + Python Class Reference unittests/index coverage/index Doc. Coverage Report diff --git a/doc/Installation.rst b/doc/Installation.rst index 9db8aacf..c3e1e459 100644 --- a/doc/Installation.rst +++ b/doc/Installation.rst @@ -38,8 +38,10 @@ details. # Basic sphinx-reports package pip install sphinx_reports -Developers can install further dependencies for documentation generation (``doc``) or running unit tests (``test``) or -just all (``all``) dependencies. +Developers can install the |PackageName| package itself or the package with further dependencies for documentation +generation (``doc``), running unit tests (``test``) or just all (``all``) dependencies. + +See :ref:`DEP` for more details. .. tab-set:: diff --git a/doc/Overview.rst b/doc/Overview.rst index 6459c37f..1176c362 100644 --- a/doc/Overview.rst +++ b/doc/Overview.rst @@ -30,7 +30,7 @@ See the following :file:`doc/requirements.txt` file as an example with commonly sphinx_rtd_theme ~= 3.0 # Sphinx Extenstions - sphinxcontrib-mermaid ~= 0.9.2 + sphinxcontrib-mermaid ~= 1.0 autoapi ~= 2.0.1 sphinx_design ~= 0.6.1 sphinx-copybutton ~= 0.5.2 diff --git a/doc/Unittest/index.rst b/doc/Unittest/index.rst index c5664257..eec9c78e 100644 --- a/doc/Unittest/index.rst +++ b/doc/Unittest/index.rst @@ -83,7 +83,7 @@ bar. :caption: References and Reports :hidden: - sphinx_reports/sphinx_reports + Python Class Reference unittests/index coverage/index Doc. Coverage Report diff --git a/doc/conf.py b/doc/conf.py index 451e3c7e..225c3db7 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -76,7 +76,7 @@ html_context = {} ctx = ROOT / "context.json" if ctx.is_file(): - html_context.update(loads(ctx.open('r').read())) + html_context.update(loads(ctx.open("r", encoding="utf-8").read())) # ============================================================================== # Options for HTML output diff --git a/doc/requirements.txt b/doc/requirements.txt index c1eaf531..b951bd3d 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -9,15 +9,8 @@ docutils_stubs ~= 0.0.22 sphinx_rtd_theme ~= 3.0.1 # Sphinx Extenstions -#sphinxcontrib-actdiag>=0.8.5 -sphinxcontrib-mermaid >= 0.9.2 -#sphinxcontrib-seqdiag>=0.8.5 -#sphinxcontrib-textstyle>=0.2.1 -#sphinxcontrib-spelling>=2.2.0 +sphinxcontrib-mermaid ~= 1.0 autoapi ~= 2.0.1 sphinx_design ~= 0.6.1 sphinx-copybutton ~= 0.5.2 sphinx_autodoc_typehints ~= 2.5 -# changelog>=0.3.5 - -# BuildTheDocs Extensions (mostly patched Sphinx extensions) diff --git a/pyproject.toml b/pyproject.toml index 15ecc203..1e874b16 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,8 +1,8 @@ [build-system] requires = [ - "setuptools ~= 75.3", + "setuptools ~= 75.5", "wheel ~= 0.45", - "pyTooling ~= 7.0" + "pyTooling ~= 8.0" ] build-backend = "setuptools.build_meta"