Skip to content
This repository was archived by the owner on Oct 24, 2025. It is now read-only.

Commit 110ed92

Browse files
committed
Documented packaging and publishing dependencies.
1 parent 91b7b13 commit 110ed92

1 file changed

Lines changed: 61 additions & 0 deletions

File tree

doc/Dependencies.rst

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,3 +113,64 @@ the mandatory dependencies too.
113113
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+----------------------+
114114
| `sphinx_autodoc_typehints <https://GitHub.com/agronholm/sphinx-autodoc-typehints>`__ | ≥1.12.0 | `MIT <https://GitHub.com/agronholm/sphinx-autodoc-typehints/blob/master/LICENSE>`__ | *Not yet evaluated.* |
115115
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+----------------------+
116+
117+
118+
.. _dependency-packaging:
119+
120+
Packaging (Optional)
121+
********************
122+
123+
Additional Python packages needed for installation package generation. These packages are only needed for developers or
124+
on a CI server, thus sub-dependencies are not evaluated further.
125+
126+
127+
.. rubric:: Manually Installing Documentation Requirements
128+
129+
Use the :file:`build/requirements.package.txt` file to install all dependencies via ``pip3``. The file will recursively
130+
install the mandatory dependencies too.
131+
132+
.. code-block:: shell
133+
134+
pip3 install -U -r build/requirements.package.txt
135+
136+
137+
.. rubric:: Dependency List
138+
139+
+----------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------+----------------------+
140+
| **Package** | **Version** | **License** | **Dependencies** |
141+
+==========================================================+==============+===========================================================================================+======================+
142+
| `pyTooling <https://GitHub.com/pyTooling/pyTooling>`__ | ≥1.4.6 | `Apache License, 2.0 <https://GitHub.com/pyTooling/pyTooling/blob/main/LICENSE.txt>`__ | *None* |
143+
+----------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------+----------------------+
144+
| `wheel <https://GitHub.com/pypa/wheel>`__ | any | `MIT <https://github.com/pypa/wheel/blob/main/LICENSE.txt>`__ | *Not yet evaluated.* |
145+
+----------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------+----------------------+
146+
147+
148+
.. _dependency-publishing:
149+
150+
Publishing (CI-Server only)
151+
***************************
152+
153+
Additional Python packages needed for publishing the generated installation package to e.g, PyPI or any equivalent
154+
services. These packages are only needed for maintainers or on a CI server, thus sub-dependencies are not evaluated
155+
further.
156+
157+
158+
.. rubric:: Manually Installing Documentation Requirements
159+
160+
Use the :file:`build/requirements.publish.txt` file to install all dependencies via ``pip3``. The file will recursively
161+
install the mandatory dependencies too.
162+
163+
.. code-block:: shell
164+
165+
pip3 install -U -r build/requirements.publish.txt
166+
167+
168+
.. rubric:: Dependency List
169+
170+
+----------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------+----------------------+
171+
| **Package** | **Version** | **License** | **Dependencies** |
172+
+==========================================================+==============+===========================================================================================+======================+
173+
| `wheel <https://GitHub.com/pypa/wheel>`__ | any | `MIT <https://github.com/pypa/wheel/blob/main/LICENSE.txt>`__ | *Not yet evaluated.* |
174+
+----------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------+----------------------+
175+
| `Twine <https://GitHub.com/pypa/twine/>`__ | any | `Apache License, 2.0 <https://github.com/pypa/twine/blob/main/LICENSE>`__ | *Not yet evaluated.* |
176+
+----------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------+----------------------+

0 commit comments

Comments
 (0)