Skip to content

Commit c3bcfc2

Browse files
PaebbelsPaebbels
committed
General Updates.
1 parent 1fda0fc commit c3bcfc2

17 files changed

+316
-99
lines changed

‎.btd.yml

-9
This file was deleted.

‎.github/pull_request_template.md

+16-2
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,30 @@
11
# New Features
2-
2+
3+
* tbd
34
* tbd
45

56
# Changes
67

8+
* tbd
79
* tbd
810

911
# Bug Fixes
1012

13+
* tbd
14+
* tbd
15+
16+
# Documentation
17+
18+
* tbd
19+
* tbd
20+
21+
# Unit Tests
22+
23+
* tbd
1124
* tbd
1225

1326
----------
14-
# Related PRs:
27+
# Related Issues and Pull-Requests
1528

1629
* tbd
30+
* tbd

‎.idea/pyEDAA.Launcher.iml

+5-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎doc/Dependency.rst

+14-17
Large diffs are not rendered by default.

‎doc/_static/css/override.css

+115
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
/* theme overrides */
2+
.rst-content h1,
3+
.rst-content h2 {
4+
margin-top: 24px;
5+
margin-bottom: 6px;
6+
text-decoration: underline;
7+
}
8+
9+
.rst-content h3,
10+
.rst-content h4,
11+
.rst-content h5,
12+
.rst-content h6 {
13+
margin-top: 12px;
14+
margin-bottom: 6px;
15+
}
16+
17+
.rst-content p {
18+
margin-bottom: 6px
19+
}
20+
21+
.rst-content .topic-title {
22+
font-size: larger;
23+
font-weight: 700;
24+
margin-top: 18px;
25+
margin-bottom: 6px;
26+
}
27+
28+
.rst-content p.rubric {
29+
text-decoration: underline;
30+
font-weight: 700;
31+
margin-top: 18px;
32+
margin-bottom: 16px;
33+
}
34+
35+
/* general overrides */
36+
html {
37+
font-size: 15px;
38+
}
39+
40+
footer {
41+
font-size: 95%;
42+
text-align: center
43+
}
44+
45+
footer p {
46+
margin-bottom: 0px /* 12px */;
47+
font-size: 95%
48+
}
49+
50+
section > p,
51+
.section p,
52+
.simple li {
53+
text-align: justify
54+
}
55+
56+
/* wyrm overrides */
57+
.wy-menu-vertical header,
58+
.wy-menu-vertical p.caption {
59+
color: #9b9b9b /* #55a5d9 */;
60+
padding: 0 0.809em /* 0 1.618em */;
61+
margin: 6px 0 0 0 /* 12px 0 0 */;
62+
border-top: 1px solid #9b9b9b;
63+
}
64+
65+
.wy-side-nav-search {
66+
margin-bottom: 0 /* .809em */;
67+
background-color: #333333 /* #2980b9 */;
68+
/* BTD: */
69+
/*color: #fcfcfc*/
70+
}
71+
72+
.wy-side-nav-search input[type=text] {
73+
border-radius: 0px /* 50px */;
74+
}
75+
76+
.wy-side-nav-search .wy-dropdown > a, .wy-side-nav-search > a {
77+
/* BTD: */
78+
/*color: #fcfcfc;*/
79+
margin-bottom: 0.404em /* .809em */;
80+
}
81+
82+
.wy-side-nav-search > div.version {
83+
margin: 0 0 6px 0;
84+
/* BTD: */
85+
/*margin-top: -.4045em;*/
86+
}
87+
88+
.wy-nav .wy-menu-vertical a:hover {
89+
background-color: #333333 /* #2980b9 */;
90+
}
91+
92+
.wy-nav-content {
93+
max-width: 1600px /* 800px */ ;
94+
}
95+
96+
.wy-nav-top {
97+
background: #333333 /* #2980b9 */;
98+
}
99+
100+
/* Sphinx Design */
101+
.sd-tab-set {
102+
margin: 0
103+
}
104+
105+
.sd-tab-set > label {
106+
padding-top: .5em;
107+
padding-right: 1em;
108+
padding-bottom: .5em;
109+
padding-left: 1em
110+
}
111+
112+
.sd-container-fluid {
113+
padding-left: 0;
114+
padding-right: 0;
115+
}

‎doc/_templates/autoapi/module.rst

+82-32
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
1-
.. # Template modified by Patrick Lehmann
1+
.. # Template modified by Patrick Lehmann
22
* removed automodule on top, because private members are activated for autodoc (no doubled documentation).
33
* Made sections like 'submodules' bold text, but no headlines to reduce number of ToC levels.
44
5-
=={{ '=' * node.name|length }}==
6-
``{{ node.name }}``
7-
=={{ '=' * node.name|length }}==
5+
{{ '=' * node.name|length }}
6+
{{ node.name }}
7+
{{ '=' * node.name|length }}
88

9-
.. py:module:: {{ node.name }}
9+
.. automodule:: {{ node.name }}
1010

1111
{##}
1212
{%- block modules -%}
1313
{%- if subnodes %}
1414

1515
**Submodules**
1616

17-
1817
.. toctree::
18+
:maxdepth: 1
1919
{% for item in subnodes %}
2020
{{ item.name }}
2121
{%- endfor %}
@@ -25,7 +25,17 @@
2525
{##}
2626
.. currentmodule:: {{ node.name }}
2727
{##}
28-
{%- block functions -%}
28+
29+
{%- if node.variables %}
30+
31+
**Variables**
32+
33+
{% for item, obj in node.variables.items() -%}
34+
- :py:data:`{{ item }}`
35+
{#{ obj|summary }#}
36+
{% endfor -%}
37+
{%- endif -%}
38+
2939
{%- if node.functions %}
3040

3141
**Functions**
@@ -35,15 +45,19 @@
3545
{{ obj|summary }}
3646

3747
{% endfor -%}
48+
{%- endif -%}
3849

39-
{% for item in node.functions %}
40-
.. autofunction:: {{ item }}
41-
{##}
42-
{%- endfor -%}
50+
{%- if node.exceptions %}
51+
52+
**Exceptions**
53+
54+
{% for item, obj in node.exceptions.items() -%}
55+
- :py:exc:`{{ item }}`:
56+
{{ obj|summary }}
57+
58+
{% endfor -%}
4359
{%- endif -%}
44-
{%- endblock -%}
4560

46-
{%- block classes -%}
4761
{%- if node.classes %}
4862

4963
**Classes**
@@ -53,14 +67,40 @@
5367
{{ obj|summary }}
5468

5569
{% endfor -%}
70+
{%- endif -%}
5671

57-
{% for item in node.classes %}
58-
.. autoclass:: {{ item }}
59-
:members:
72+
{%- block variables -%}
73+
{%- if node.variables %}
6074

61-
.. rubric:: Inheritance
62-
.. inheritance-diagram:: {{ item }}
63-
:parts: 1
75+
---------------------
76+
77+
**Variables**
78+
79+
{#% for item, obj in node.variables.items() -%}
80+
- :py:data:`{{ item }}`
81+
{% endfor -%#}
82+
83+
{% for item, obj in node.variables.items() %}
84+
.. autodata:: {{ item }}
85+
:annotation:
86+
87+
.. code-block:: text
88+
89+
{{ obj|pprint|indent(6) }}
90+
{##}
91+
{%- endfor -%}
92+
{%- endif -%}
93+
{%- endblock -%}
94+
95+
{%- block functions -%}
96+
{%- if node.functions %}
97+
98+
---------------------
99+
100+
**Functions**
101+
102+
{% for item in node.functions %}
103+
.. autofunction:: {{ item }}
64104
{##}
65105
{%- endfor -%}
66106
{%- endif -%}
@@ -69,13 +109,15 @@
69109
{%- block exceptions -%}
70110
{%- if node.exceptions %}
71111

112+
---------------------
113+
72114
**Exceptions**
73115

74-
{% for item, obj in node.exceptions.items() -%}
116+
{#% for item, obj in node.exceptions.items() -%}
75117
- :py:exc:`{{ item }}`:
76118
{{ obj|summary }}
77119

78-
{% endfor -%}
120+
{% endfor -%#}
79121

80122
{% for item in node.exceptions %}
81123
.. autoexception:: {{ item }}
@@ -88,22 +130,30 @@
88130
{%- endif -%}
89131
{%- endblock -%}
90132

91-
{%- block variables -%}
92-
{%- if node.variables %}
133+
{%- block classes -%}
134+
{%- if node.classes %}
93135

94-
**Variables**
136+
---------------------
95137

96-
{% for item, obj in node.variables.items() -%}
97-
- :py:data:`{{ item }}`
98-
{% endfor -%}
138+
**Classes**
99139

100-
{% for item, obj in node.variables.items() %}
101-
.. autodata:: {{ item }}
102-
:annotation:
140+
{#% for item, obj in node.classes.items() -%}
141+
- :py:class:`{{ item }}`:
142+
{{ obj|summary }}
103143

104-
.. code-block:: text
144+
{% endfor -%#}
105145

106-
{{ obj|pprint|indent(6) }}
146+
{% for item in node.classes %}
147+
.. autoclass:: {{ item }}
148+
:members:
149+
:private-members:
150+
:special-members:
151+
:inherited-members:
152+
:exclude-members: __weakref__
153+
154+
.. rubric:: Inheritance
155+
.. inheritance-diagram:: {{ item }}
156+
:parts: 1
107157
{##}
108158
{%- endfor -%}
109159
{%- endif -%}

‎doc/_templates/autoapi/package.rst

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
.. # Template created by Patrick Lehmann
2+
3+
Python Class Reference
4+
######################
5+
6+
Reference of all packages and modules:
7+
8+
.. automodule:: {{ node.name }}
9+
10+
.. toctree::
11+
:maxdepth: 1
12+
{% for item in subnodes %}
13+
{{ item.name }}
14+
{%- endfor %}

‎doc/conf.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@
6161
# ==============================================================================
6262
prologPath = Path("prolog.inc")
6363
try:
64-
with prologPath.open("r") as fileHandle:
64+
with prologPath.open("r", encoding="utf-8") as fileHandle:
6565
rst_prolog = fileHandle.read()
6666
except Exception as ex:
6767
print(f"[ERROR:] While reading '{prologPath}'.")
@@ -205,8 +205,8 @@
205205
# Sphinx.Ext.ExtLinks
206206
# ==============================================================================
207207
extlinks = {
208-
"ghissue": ('https://GitHub.com/edaa-org/pyEDAA.Launcher/issues/%s', 'issue #'),
209-
"ghpull": ('https://GitHub.com/edaa-org/pyEDAA.Launcher/pull/%s', 'pull request #'),
208+
"ghissue": ('https://GitHub.com/edaa-org/pyEDAA.Launcher/issues/%s', 'issue #%s'),
209+
"ghpull": ('https://GitHub.com/edaa-org/pyEDAA.Launcher/pull/%s', 'pull request #%s'),
210210
"ghsrc": ('https://GitHub.com/edaa-org/pyEDAA.Launcher/blob/main/%s?ts=2', None),
211211
}
212212

0 commit comments

Comments
 (0)