diff --git a/dist/requirements.txt b/dist/requirements.txt
index 9fd7921c..a414030a 100644
--- a/dist/requirements.txt
+++ b/dist/requirements.txt
@@ -1,2 +1,2 @@
-wheel>=0.38.1
+wheel >= 0.40.0
twine >= 4.0.2
diff --git a/doc/Dependency.rst b/doc/Dependency.rst
index e5d867d2..8d87ecb6 100644
--- a/doc/Dependency.rst
+++ b/doc/Dependency.rst
@@ -1,34 +1,60 @@
.. _DEP:
-Dependency
-##########
+Dependencies
+############
-.. |img-ProjectModel-lib-status| image:: https://img.shields.io/librariesio/release/pypi/pyVersioning
+.. |img-pyTooling-lib-status| image:: https://img.shields.io/librariesio/release/pypi/sphinx-reports
:alt: Libraries.io status for latest release
:height: 22
- :target: https://libraries.io/github/Paebbels/pyVersioning
-.. |img-ProjectModel-req-status| image:: https://img.shields.io/requires/github/Paebbels/pyVersioning
- :alt: Requires.io
+ :target: https://libraries.io/github/pyTooling/sphinx-reports
+.. |img-pyTooling-vul-status| image:: https://img.shields.io/snyk/vulnerabilities/github/pyTooling/sphinx-reports
+ :alt: Snyk Vulnerabilities for GitHub Repo
:height: 22
- :target: https://requires.io/github/Paebbels/pyVersioning/requirements/?branch=main
+ :target: https://img.shields.io/snyk/vulnerabilities/github/pyTooling/sphinx-reports
+------------------------------------------+------------------------------------------+
-| `Libraries.io `_ | `Requires.io `_ |
+| `Libraries.io `_ | Vulnerabilities Summary |
+==========================================+==========================================+
-| |img-ProjectModel-lib-status| | |img-ProjectModel-req-status| |
+| |img-pyTooling-lib-status| | |img-pyTooling-vul-status| |
+------------------------------------------+------------------------------------------+
.. _DEP/package:
-pyVersioning Package
-********************
+sphinx-reports Package (Mandatory)
+**********************************
+
+.. rubric:: Manually Installing Package Requirements
+
+Use the :file:`requirements.txt` file to install all dependencies via ``pip3`` or install the package directly from
+PyPI (see :ref:`INSTALL`).
+
+.. tab-set::
+
+ .. tab-item:: Linux/MacOS
+ :sync: Linux
+
+ .. code-block:: bash
+
+ pip3 install -U -r requirements.txt
+
+ .. tab-item:: Windows
+ :sync: Windows
+
+ .. code-block:: powershell
+
+ pip install -U -r requirements.txt
-+-------------------------------------------------------------------------------+-------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
-| **Package** | **Version** | **License** | **Dependencies** |
-+===============================================================================+=============+======================================================================================================+===========================================================================================================================================================+
-| `pyTooling `__ | ≥5.0.0 | `Apache License, 2.0 `__ | *None* |
-+-------------------------------------------------------------------------------+-------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
+
+.. rubric:: Dependency List
+
+When installed as ``pyTooling``:
+
++-----------------------------------------------------------------+-------------+-------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+| **Package** | **Version** | **License** | **Dependencies** |
++=================================================================+=============+===========================================================================================+========================================================================================================================================================+
+| `pyTooling `__ | ≥5.0.0 | `Apache License, 2.0 `__ | *None* |
++-----------------------------------------------------------------+-------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
.. TODO:: document the dependency to
@@ -39,8 +65,11 @@ pyVersioning Package
.. _DEP/testing:
+Unit Testing (Optional)
+***********************
+
Unit Testing / Coverage / Type Checking (Optional)
-**************************************************
+==================================================
Additional Python packages needed for testing, code coverage collection and static type checking. These packages are
only needed for developers or on a CI server, thus sub-dependencies are not evaluated further.
@@ -51,12 +80,23 @@ only needed for developers or on a CI server, thus sub-dependencies are not eval
Use the :file:`tests/requirements.txt` file to install all dependencies via ``pip3``. The file will recursively install
the mandatory dependencies too.
-.. code-block:: shell
+.. tab-set::
- pip3 install -U -r tests/requirements.txt
+ .. tab-item:: Linux/MacOS
+ :sync: Linux
+ .. code-block:: bash
-.. rubric:: Dependency List
+ pip install -U -r tests/requirements.txt
+
+ .. tab-item:: Windows
+ :sync: Windows
+
+ .. code-block:: powershell
+
+ pip3 install -U -r tests\requirements.txt
+
+.. rubric:: Dependency List - Unit Testing
+---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
| **Package** | **Version** | **License** | **Dependencies** |
@@ -71,7 +111,7 @@ the mandatory dependencies too.
+---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
| `typing-extensions `__ | ≥4.7.1 | `PSF-2.0 `__ | *Not yet evaluated.* |
+---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
-| `lxml `__ | ≥4.6.4 | `BSD 3-Clause `__ | *Not yet evaluated.* |
+| `lxml `__ | ≥4.9 | `BSD 3-Clause `__ | *Not yet evaluated.* |
+---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
@@ -89,9 +129,21 @@ CI server, thus sub-dependencies are not evaluated further.
Use the :file:`doc/requirements.txt` file to install all dependencies via ``pip3``. The file will recursively install
the mandatory dependencies too.
-.. code-block:: shell
+.. tab-set::
+
+ .. tab-item:: Linux/MacOS
+ :sync: Linux
+
+ .. code-block:: bash
+
+ pip install -U -r doc/requirements.txt
+
+ .. tab-item:: Windows
+ :sync: Windows
- pip3 install -U -r doc/requirements.txt
+ .. code-block:: powershell
+
+ pip3 install -U -r doc\requirements.txt
.. rubric:: Dependency List
@@ -103,9 +155,15 @@ the mandatory dependencies too.
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| `Sphinx `__ | ≥5.3.0 | `BSD 3-Clause `__ | *Not yet evaluated.* |
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
+| `sphinxcontrib-mermaid `__ | ≥0.9.2 | `BSD `__ | *Not yet evaluated.* |
++-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
+| `autoapi `__ | ≥2.0.1 | `Apache License, 2.0 `__ | *Not yet evaluated.* |
++-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| `sphinx_btd_theme `__ | ≥0.5.2 | `MIT `__ | *Not yet evaluated.* |
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
-| !! `sphinx_fontawesome `__ | ≥0.0.6 | `GPL 2.0 `__ | *Not yet evaluated.* |
+| `sphinx_design `__ | ≥0.5.0 | `MIT `__ | *Not yet evaluated.* |
++-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
+| `sphinx-copybutton `__ | ≥0.5.2 | `MIT `__ | *Not yet evaluated.* |
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| `sphinx_autodoc_typehints `__ | ≥1.24.0 | `MIT `__ | *Not yet evaluated.* |
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -132,9 +190,21 @@ on a CI server, thus sub-dependencies are not evaluated further.
Use the :file:`build/requirements.txt` file to install all dependencies via ``pip3``. The file will recursively
install the mandatory dependencies too.
-.. code-block:: shell
+.. tab-set::
+
+ .. tab-item:: Linux/MacOS
+ :sync: Linux
- pip3 install -U -r build/requirements.txt
+ .. code-block:: bash
+
+ pip install -U -r build/requirements.txt
+
+ .. tab-item:: Windows
+ :sync: Windows
+
+ .. code-block:: powershell
+
+ pip3 install -U -r build\requirements.txt
.. rubric:: Dependency List
@@ -144,7 +214,7 @@ install the mandatory dependencies too.
+============================================================================+==============+==========================================================================================================+======================================================================================================================================================+
| `pyTooling `__ | ≥5.0.0 | `Apache License, 2.0 `__ | *None* |
+----------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
-| `wheel `__ | ≥0.38.1 | `MIT `__ | *Not yet evaluated.* |
+| `wheel `__ | ≥0.40.0 | `MIT `__ | *Not yet evaluated.* |
+----------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -163,9 +233,21 @@ further.
Use the :file:`dist/requirements.txt` file to install all dependencies via ``pip3``. The file will recursively
install the mandatory dependencies too.
-.. code-block:: shell
+.. tab-set::
+
+ .. tab-item:: Linux/MacOS
+ :sync: Linux
+
+ .. code-block:: bash
+
+ pip install -U -r dist/requirements.txt
+
+ .. tab-item:: Windows
+ :sync: Windows
+
+ .. code-block:: powershell
- pip3 install -U -r dist/requirements.txt
+ pip3 install -U -r dist\requirements.txt
.. rubric:: Dependency List
@@ -173,7 +255,7 @@ install the mandatory dependencies too.
+----------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------+----------------------+
| **Package** | **Version** | **License** | **Dependencies** |
+==========================================================+==============+===========================================================================================+======================+
-| `wheel `__ | ≥0.38.1 | `MIT `__ | *Not yet evaluated.* |
+| `wheel `__ | ≥0.40.0 | `MIT `__ | *Not yet evaluated.* |
+----------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------+----------------------+
-| `Twine `__ | any | `Apache License, 2.0 `__ | *Not yet evaluated.* |
+| `Twine `__ | ≥4.0.2 | `Apache License, 2.0 `__ | *Not yet evaluated.* |
+----------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------+----------------------+
diff --git a/doc/requirements.txt b/doc/requirements.txt
index e5bab80d..5940e7a1 100644
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@@ -1,12 +1,25 @@
-r ../requirements.txt
pyTooling >= 5.0.0, < 6.0
+colorama >= 0.4.6
# Enforce latest version on ReadTheDocs
-sphinx >= 7.1.0, < 8.0
+sphinx >= 7.2, < 8.0
+docutils >= 0.18.0, < 0.19.0
+
+# ReadTheDocs Theme
+sphinx_rtd_theme ~= 2.0.0
# Sphinx Extenstions
-sphinxcontrib-mermaid>=0.7.1
-autoapi>=2.0.1
-sphinx_fontawesome>=0.0.6
-sphinx_autodoc_typehints >= 1.24.0
+#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
+autoapi >= 2.0.1
+sphinx_design >= 0.5.0
+sphinx-copybutton >= 0.5.2
+sphinx_autodoc_typehints >= 1.25.2
+# changelog>=0.3.5
+
+# BuildTheDocs Extensions (mostly patched Sphinx extensions)