Skip to content

Commit 6ab3631

Browse files
PaebbelsPaebbels
committed
Switched documentation from BTD to vanilla Sphinx.
1 parent 4086248 commit 6ab3631

File tree

21 files changed

+1321
-201
lines changed

21 files changed

+1321
-201
lines changed

‎.gitignore

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,32 @@ __pycache__/
66
.coverage
77
.cov
88
coverage.xml
9+
/report/coverage
10+
11+
# mypy
12+
/report/typing
13+
14+
# pytest
15+
/report/unit
916

1017
# setuptools
11-
/build/
12-
/dist/
18+
/build/**/*.*
19+
/dist/**/*.*
1320
/*.egg-info
1421

1522
# Dependencies
1623
!requirements.txt
1724

1825
# Sphinx
19-
/doc/_build/
20-
/doc/_theme/
21-
/doc/pySystemRDLModel/**/*.*
22-
!/doc/pySystemRDLModel/index.rst
26+
doc/_build/
27+
doc/pySystemRDLModel/**/*.*
28+
!doc/pySystemRDLModel/index.rst
2329

24-
# PyCharm project files
30+
# BuildTheDocs
31+
doc/_theme/**/*.*
32+
33+
# IntelliJ project files
2534
/.idea/workspace.xml
35+
36+
# Git files
37+
!.git*

‎doc/Dependency.rst

Lines changed: 107 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,53 @@
1-
.. _dependency:
1+
.. _DEP:
22

3-
Dependency
4-
##########
3+
Dependencies
4+
############
55

66
.. |img-pySystemRDLModel-lib-status| image:: https://img.shields.io/librariesio/release/pypi/pySystemRDLModel
77
:alt: Libraries.io status for latest release
88
:height: 22
99
:target: https://libraries.io/github/edaa-org/pySystemRDLModel
10-
.. |img-pySystemRDLModel-req-status| image:: https://img.shields.io/requires/github/edaa-org/pySystemRDLModel
11-
:alt: Requires.io
10+
.. |img-pySystemRDLModel-vul-status| image:: https://img.shields.io/snyk/vulnerabilities/github/edaa-org/pySystemRDLModel
11+
:alt: Snyk Vulnerabilities for GitHub Repo
1212
:height: 22
13-
:target: https://requires.io/github/edaa-org/pySystemRDLModel/requirements/?branch=main
13+
:target: https://img.shields.io/snyk/vulnerabilities/github/edaa-org/pySystemRDLModel
1414

1515
+------------------------------------------+------------------------------------------+
16-
| `Libraries.io <https://libraries.io/>`_ | `Requires.io <https://requires.io/>`_ |
16+
| `Libraries.io <https://libraries.io/>`_ | Vulnerabilities Summary |
1717
+==========================================+==========================================+
18-
| |img-pySystemRDLModel-lib-status| | |img-pySystemRDLModel-req-status| |
18+
| |img-pySystemRDLModel-lib-status| | |img-pySystemRDLModel-vul-status| |
1919
+------------------------------------------+------------------------------------------+
2020

21+
.. _DEP/package:
2122

22-
.. _dependency-package:
23+
pySystemRDLModel Package (Mandatory)
24+
************************************
2325

24-
pySystemRDLModel Package
25-
************************
26+
.. rubric:: Manually Installing Package Requirements
2627

27-
*None*
28+
Use the :file:`requirements.txt` file to install all dependencies via ``pip3`` or install the package directly from
29+
PyPI (see :ref:`INSTALL`).
30+
31+
.. tab-set::
32+
33+
.. tab-item:: Linux/macOS
34+
:sync: Linux
35+
36+
.. code-block:: bash
37+
38+
pip3 install -U -r requirements.txt
39+
40+
.. tab-item:: Windows
41+
:sync: Windows
42+
43+
.. code-block:: powershell
44+
45+
pip install -U -r requirements.txt
46+
47+
48+
.. rubric:: Dependency List
49+
50+
When installed as ``pySystemRDLModel``:
2851

2952
+--------------------------------------------------------+-------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
3053
| **Package** | **Version** | **License** | **Dependencies** |
@@ -33,10 +56,13 @@ pySystemRDLModel Package
3356
+--------------------------------------------------------+-------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
3457

3558

36-
.. _dependency-testing:
59+
.. _DEP/testing:
60+
61+
Unit Testing (Optional)
62+
***********************
3763

3864
Unit Testing / Coverage / Type Checking (Optional)
39-
**************************************************
65+
==================================================
4066

4167
Additional Python packages needed for testing, code coverage collection and static type checking. These packages are
4268
only needed for developers or on a CI server, thus sub-dependencies are not evaluated further.
@@ -47,17 +73,28 @@ only needed for developers or on a CI server, thus sub-dependencies are not eval
4773
Use the :file:`tests/requirements.txt` file to install all dependencies via ``pip3``. The file will recursively install
4874
the mandatory dependencies too.
4975

50-
.. code-block:: shell
76+
.. tab-set::
5177

52-
pip3 install -U -r tests/requirements.txt
78+
.. tab-item:: Linux/macOS
79+
:sync: Linux
5380

81+
.. code-block:: bash
5482
55-
.. rubric:: Dependency List
83+
pip install -U -r tests/requirements.txt
84+
85+
.. tab-item:: Windows
86+
:sync: Windows
87+
88+
.. code-block:: powershell
89+
90+
pip3 install -U -r tests\requirements.txt
91+
92+
.. rubric:: Dependency List - Unit Testing
5693

5794
+---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
5895
| **Package** | **Version** | **License** | **Dependencies** |
5996
+=====================================================================+=============+========================================================================================+======================+
60-
| `pytest <https://github.com/pytest-dev/pytest>`__ | ≥8.3 | `MIT <https://github.com/pytest-dev/pytest/blob/master/LICENSE>`__ | *Not yet evaluated.* |
97+
| `pytest <https://github.com/pytest-dev/pytest>`__ | ≥8.3 | `MIT <https://github.com/pytest-dev/pytest/blob/master/LICENSE>`__ | *Not yet evaluated.* |
6198
+---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
6299
| `pytest-cov <https://github.com/pytest-dev/pytest-cov>`__ | ≥6.0 | `MIT <https://github.com/pytest-dev/pytest-cov/blob/master/LICENSE>`__ | *Not yet evaluated.* |
63100
+---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
@@ -71,7 +108,7 @@ the mandatory dependencies too.
71108
+---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
72109

73110

74-
.. _dependency-documentation:
111+
.. _DEP/documentation:
75112

76113
Sphinx Documentation (Optional)
77114
*******************************
@@ -85,9 +122,21 @@ CI server, thus sub-dependencies are not evaluated further.
85122
Use the :file:`doc/requirements.txt` file to install all dependencies via ``pip3``. The file will recursively install
86123
the mandatory dependencies too.
87124

88-
.. code-block:: shell
125+
.. tab-set::
126+
127+
.. tab-item:: Linux/macOS
128+
:sync: Linux
89129

90-
pip3 install -U -r doc/requirements.txt
130+
.. code-block:: bash
131+
132+
pip install -U -r doc/requirements.txt
133+
134+
.. tab-item:: Windows
135+
:sync: Windows
136+
137+
.. code-block:: powershell
138+
139+
pip3 install -U -r doc\requirements.txt
91140
92141
93142
.. rubric:: Dependency List
@@ -99,15 +148,21 @@ the mandatory dependencies too.
99148
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
100149
| `Sphinx <https://github.com/sphinx-doc/sphinx>`__ | ≥8.1 | `BSD 3-Clause <https://github.com/sphinx-doc/sphinx/blob/master/LICENSE>`__ | *Not yet evaluated.* |
101150
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
151+
| `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.* |
152+
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
153+
| `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.* |
154+
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
102155
| `sphinx_btd_theme <https://github.com/buildthedocs/sphinx.theme>`__ | ≥0.5.2 | `MIT <https://github.com/buildthedocs/sphinx.theme/blob/master/LICENSE>`__ | *Not yet evaluated.* |
103156
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
104-
| !! `sphinx_fontawesome <https://github.com/fraoustin/sphinx_fontawesome>`__ | ≥0.0.6 | `GPL 2.0 <https://github.com/fraoustin/sphinx_fontawesome/blob/master/LICENSE>`__ | *Not yet evaluated.* |
157+
| `sphinx_design <https://github.com/executablebooks/sphinx-design>`__ | ≥0.6 | `MIT <https://github.com/executablebooks/sphinx-design/blob/main/LICENSE>`__ | *Not yet evaluated.* |
158+
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
159+
| `sphinx-copybutton <https://github.com/executablebooks/sphinx-copybutton>`__ | ≥0.5 | `MIT <https://github.com/executablebooks/sphinx-copybutton/blob/master/LICENSE>`__ | *Not yet evaluated.* |
105160
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
106161
| `sphinx_autodoc_typehints <https://github.com/agronholm/sphinx-autodoc-typehints>`__ | ≥2.5 | `MIT <https://github.com/agronholm/sphinx-autodoc-typehints/blob/master/LICENSE>`__ | *Not yet evaluated.* |
107162
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
108163

109164

110-
.. _dependency-packaging:
165+
.. _DEP/packaging:
111166

112167
Packaging (Optional)
113168
********************
@@ -121,9 +176,21 @@ on a CI server, thus sub-dependencies are not evaluated further.
121176
Use the :file:`build/requirements.txt` file to install all dependencies via ``pip3``. The file will recursively
122177
install the mandatory dependencies too.
123178

124-
.. code-block:: shell
179+
.. tab-set::
180+
181+
.. tab-item:: Linux/macOS
182+
:sync: Linux
183+
184+
.. code-block:: bash
125185
126-
pip3 install -U -r build/requirements.txt
186+
pip install -U -r build/requirements.txt
187+
188+
.. tab-item:: Windows
189+
:sync: Windows
190+
191+
.. code-block:: powershell
192+
193+
pip3 install -U -r build\requirements.txt
127194
128195
129196
.. rubric:: Dependency List
@@ -137,7 +204,7 @@ install the mandatory dependencies too.
137204
+----------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
138205

139206

140-
.. _dependency-publishing:
207+
.. _DEP/publishing:
141208

142209
Publishing (CI-Server only)
143210
***************************
@@ -152,9 +219,21 @@ further.
152219
Use the :file:`dist/requirements.txt` file to install all dependencies via ``pip3``. The file will recursively
153220
install the mandatory dependencies too.
154221

155-
.. code-block:: shell
222+
.. tab-set::
223+
224+
.. tab-item:: Linux/macOS
225+
:sync: Linux
226+
227+
.. code-block:: bash
228+
229+
pip install -U -r dist/requirements.txt
230+
231+
.. tab-item:: Windows
232+
:sync: Windows
233+
234+
.. code-block:: powershell
156235
157-
pip3 install -U -r dist/requirements.txt
236+
pip3 install -U -r dist\requirements.txt
158237
159238
160239
.. rubric:: Dependency List

‎doc/Doc-License.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. _DOCLICENSE:
22

3-
.. Note:: This is a local copy of the `Creative Commons - Attribution 4.0 International (CC BY 4.0) <https://creativecommons.org/licenses/by/4.0/legalcode>`__.
3+
.. note:: This is a local copy of the `Creative Commons - Attribution 4.0 International (CC BY 4.0) <https://creativecommons.org/licenses/by/4.0/legalcode>`__.
44

5-
.. Attention:: This **CC BY 4.0** license applies only to the **documentation** of this project.
5+
.. attention:: This **CC BY 4.0** license applies only to the **documentation** of this project.
66

77

88
Creative Commons Attribution 4.0 International

‎doc/DocCoverage.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Documentation Coverage
2+
######################
3+
4+
Documentation coverage generated by `docstr-coverage <https://github.com/HunterMcGushion/docstr_coverage>`__.
5+
6+
.. report:doc-coverage::
7+
:packageid: src

0 commit comments

Comments
 (0)