Skip to content

Commit

Permalink
Bumped dependencies.
Browse files Browse the repository at this point in the history
  • Loading branch information
@Paebbels
Paebbels committed Dec 9, 2024
1 parent 2675df9 commit a3587b1
Show file tree
Hide file tree
Showing 11 changed files with 26 additions and 26 deletions.
5 changes: 3 additions & 2 deletions .github/workflows/Pipeline.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -91,8 +92,8 @@ jobs:
Documentation:
uses: pyTooling/Actions/.github/workflows/SphinxDocumentation.yml@dev
needs:
- UnitTestingParams
- ConfigParams
- UnitTestingParams
- PublishTestResults
- PublishCoverageResults
# - VerifyDocs
Expand Down
10 changes: 7 additions & 3 deletions .gitignore
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,13 @@ __pycache__/
.coverage
.cov
coverage.xml
/report/coverage

# Generated reports
report/
# mypy
/report/typing

# pytest
/report/unit

# setuptools
/build/**/*.*
Expand All @@ -26,7 +30,7 @@ doc/sphinx_reports/**/*.*
# BuildTheDocs
doc/_theme/**/*.*

# IntelliJ project files
# PyCharm project files
/.idea/workspace.xml

# Git files
Expand Down
2 changes: 1 addition & 1 deletion doc/CodeCov/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ bar.
:caption: References and Reports
:hidden:
sphinx_reports/sphinx_reports
Python Class Reference <sphinx_reports/sphinx_reports>
unittests/index
coverage/index
Doc. Coverage Report <DocCoverage>
Expand Down
8 changes: 4 additions & 4 deletions doc/Dependency.rst
View file
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>`__ | ≥7.0 | `Apache License, 2.0 <https://GitHub.com/pyTooling/pyTooling/blob/main/LICENSE.txt>`__ | *None* |
| `pyTooling <https://GitHub.com/pyTooling/pyTooling>`__ | ≥8.0 | `Apache License, 2.0 <https://GitHub.com/pyTooling/pyTooling/blob/main/LICENSE.txt>`__ | *None* |
+-----------------------------------------------------------------+-------------+-------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+

.. TODO:: document the dependency to
Expand Down Expand Up @@ -152,11 +152,11 @@ the mandatory dependencies too.
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Package** | **Version** | **License** | **Dependencies** |
+=================================================================================================+==============+==========================================================================================================+======================================================================================================================================================+
| `pyTooling <https://GitHub.com/pyTooling/pyTooling>`__ | ≥7.0 | `Apache License, 2.0 <https://GitHub.com/pyTooling/pyTooling/blob/main/LICENSE.md>`__ | *None* |
| `pyTooling <https://GitHub.com/pyTooling/pyTooling>`__ | ≥8.0 | `Apache License, 2.0 <https://GitHub.com/pyTooling/pyTooling/blob/main/LICENSE.md>`__ | *None* |
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| `Sphinx <https://GitHub.com/sphinx-doc/sphinx>`__ | ≥8.1 | `BSD 3-Clause <https://GitHub.com/sphinx-doc/sphinx/blob/master/LICENSE>`__ | *Not yet evaluated.* |
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| `sphinxcontrib-mermaid <https://GitHub.com/mgaitan/sphinxcontrib-mermaid>`__ | ≥0.9.2 | `BSD <https://GitHub.com/mgaitan/sphinxcontrib-mermaid/blob/master/LICENSE.rst>`__ | *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.* |
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| `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>`__ | ≥7.0 | `Apache License, 2.0 <https://GitHub.com/pyTooling/pyTooling/blob/main/LICENSE.md>`__ | *None* |
| `pyTooling <https://GitHub.com/pyTooling/pyTooling>`__ | ≥8.0 | `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
2 changes: 1 addition & 1 deletion doc/DocCov/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ bar.
:caption: References and Reports
:hidden:
sphinx_reports/sphinx_reports
Python Class Reference <sphinx_reports/sphinx_reports>
unittests/index
coverage/index
Doc. Coverage Report <DocCoverage>
Expand Down
6 changes: 4 additions & 2 deletions doc/Installation.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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::

Expand Down
2 changes: 1 addition & 1 deletion doc/Overview.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion doc/Unittest/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ bar.
:caption: References and Reports
:hidden:
sphinx_reports/sphinx_reports
Python Class Reference <sphinx_reports/sphinx_reports>
unittests/index
coverage/index
Doc. Coverage Report <DocCoverage>
Expand Down
2 changes: 1 addition & 1 deletion doc/conf.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
9 changes: 1 addition & 8 deletions doc/requirements.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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)
4 changes: 2 additions & 2 deletions pyproject.toml
View file
Original file line number Diff line number Diff line change
@@ -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"

Expand Down

0 comments on commit a3587b1

Please sign in to comment.