Skip to content

Commit 2493746

Browse files
sebastian-petersebastian-peter
authored
Merge pull request #1142 from ie3-institute/ps/#1137-evalRstToMystSyntax
Converted all eval-rst instances in rtd to myst syntax
2 parents a1a5270 + 240da4b commit 2493746

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+556
-582
lines changed

‎CHANGELOG.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1414

1515
### Changed
1616
- Storage minimum level parameter removed from cylindrical thermal storage [#1123](https://github.com/ie3-institute/PowerSystemDataModel/issues/1123)
17+
- Converted eval-rst to myst syntax in ReadTheDocs, fixed line wrapping and widths[#1137](https://github.com/ie3-institute/PowerSystemDataModel/issues/1137)
1718

1819
## [5.1.0] - 2024-06-24
1920

‎docs/readthedocs/_static/css/theme_override.css‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,8 @@
1010
}
1111
.wy-table-responsive table th p {
1212
margin-bottom: 0;
13-
}
13+
}
14+
15+
table.wrapping td {
16+
white-space: normal;
17+
}

‎docs/readthedocs/io/csvfiles.md‎

Lines changed: 68 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -24,61 +24,59 @@ You may extend / alter the naming with pre- or suffix by calling `new EntityPers
2424

2525
### Input
2626

27-
```{eval-rst}
28-
.. list-table::
29-
:widths: auto
27+
```{list-table}
3028
:header-rows: 1
29+
:widths: auto
3130
32-
* - Model
33-
- File Name
34-
* - operator
35-
- *prefix_* operator_input *_suffix*
36-
* - node
37-
- *prefix_* node_input *_suffix*
38-
* - line
39-
- | *prefix_* line_input *_suffix*
40-
| *prefix_* line_type_input *_suffix*
41-
* - switch
42-
- *prefix_* switch_input *_suffix*
43-
* - two winding transformer
44-
- | *prefix_* transformer2w_input *_suffix*
45-
| *prefix_* transformer2w_type_input *_suffix*
46-
* - three winding transformer
47-
- | *prefix_* transformer3w_input *_suffix*
48-
| *prefix_* transformer3w_type_input *_suffix*
49-
* - measurement unit
50-
- *prefix_* measurement_unit_input *_suffix*
51-
* - biomass plant
52-
- | *prefix_* bm_input *_suffix*
53-
| *prefix_* bm_type_input *_suffix*
54-
* - combined heat and power plant
55-
- | *prefix_* chp_input *_suffix*
56-
| *prefix_* chp_type_input *_suffix*
57-
* - electric vehicle
58-
- | *prefix_* ev_input *_suffix*
59-
| *prefix_* ev_type_input *_suffix*
60-
* - electric vehicle charging station
61-
- *prefix_* evcs_input *_suffix*
62-
* - fixed feed in facility
63-
- *prefix_* fixed_feed_in_input *_suffix*
64-
* - heat pump
65-
- | *prefix_* hp_input *_suffix*
66-
| *prefix_* hp_type_input *_suffix*
67-
* - load
68-
- *prefix_* load_input *_suffix*
69-
* - photovoltaic power plant
70-
- *prefix_* pv_input *_suffix*
71-
* - electrical energy storage
72-
- | *prefix_* storage_input *_suffix*
73-
| *prefix_* storage_type_input *_suffix*
74-
* - wind energy converter
75-
- | *prefix_* wec_input *_suffix*
76-
| *prefix_* wec_type_input *_suffix*
77-
* - schematic node graphic
78-
- *prefix_* node_graphic_input *_suffix*
79-
* - schematic line graphic
80-
- *prefix_* line_graphic_input *_suffix*
81-
31+
* - Model
32+
- File Name
33+
* - operator
34+
- *prefix_* operator_input *_suffix*
35+
* - node
36+
- *prefix_* node_input *_suffix*
37+
* - line
38+
- *prefix_* line_input *_suffix*
39+
*prefix_* line_type_input *_suffix*
40+
* - switch
41+
- *prefix_* switch_input *_suffix*
42+
* - two winding transformer
43+
- *prefix_* transformer2w_input *_suffix*
44+
*prefix_* transformer2w_type_input *_suffix*
45+
* - three winding transformer
46+
- *prefix_* transformer3w_input *_suffix*
47+
*prefix_* transformer3w_type_input *_suffix*
48+
* - measurement unit
49+
- *prefix_* measurement_unit_input *_suffix*
50+
* - biomass plant
51+
- *prefix_* bm_input *_suffix*
52+
*prefix_* bm_type_input *_suffix*
53+
* - combined heat and power plant
54+
- *prefix_* chp_input *_suffix*
55+
*prefix_* chp_type_input *_suffix*
56+
* - electric vehicle
57+
- *prefix_* ev_input *_suffix*
58+
*prefix_* ev_type_input *_suffix*
59+
* - electric vehicle charging station
60+
- *prefix_* evcs_input *_suffix*
61+
* - fixed feed in facility
62+
- *prefix_* fixed_feed_in_input *_suffix*
63+
* - heat pump
64+
- *prefix_* hp_input *_suffix*
65+
*prefix_* hp_type_input *_suffix*
66+
* - load
67+
- *prefix_* load_input *_suffix*
68+
* - photovoltaic power plant
69+
- *prefix_* pv_input *_suffix*
70+
* - electrical energy storage
71+
- *prefix_* storage_input *_suffix*
72+
*prefix_* storage_type_input *_suffix*
73+
* - wind energy converter
74+
- *prefix_* wec_input *_suffix*
75+
*prefix_* wec_type_input *_suffix*
76+
* - schematic node graphic
77+
- *prefix_* node_graphic_input *_suffix*
78+
* - schematic line graphic
79+
- *prefix_* line_graphic_input *_suffix*
8280
```
8381

8482
### Id Coordinate
@@ -89,8 +87,7 @@ Csv id coordinate sources can have two different ways to represent their coordin
8987

9088
### Time Series
9189

92-
```{eval-rst}
93-
.. list-table::
90+
```{list-table}
9491
:widths: 50 50
9592
:header-rows: 1
9693
@@ -123,41 +120,39 @@ You can also use the Method `java.util.UUID#randomUUID` to create a UUID.
123120
This is the UUID from the example above `2fcb3e53-b94a-4b96-bea4-c469e499f1a1`.
124121

125122
The following keys are supported until now:
126-
```{eval-rst}
127-
.. list-table::
123+
```{list-table}
128124
:widths: auto
129125
:header-rows: 1
130126
131127
* - Key
132128
- Information and supported head line
133129
* - c
134-
- | An energy price (e.g. in €/MWh; c stands for charge).
135-
| Permissible head line: ``time,price``
130+
- An energy price (e.g. in €/MWh; c stands for charge).
131+
Permissible head line: ``time,price``
136132
* - p
137-
- | Active power
138-
| Permissible head line: ``time,p``
133+
- Active power
134+
Permissible head line: ``time,p``
139135
* - pq
140-
- | Active and reactive power
141-
| Permissible head line: ``time,p,q``
136+
- Active and reactive power
137+
Permissible head line: ``time,p,q``
142138
* - h
143-
- | Heat power demand
144-
| Permissible head line: ``time,h``
139+
- Heat power demand
140+
Permissible head line: ``time,h``
145141
* - ph
146-
- | Active and heat power
147-
| Permissible head line: ``time,p,h``
142+
- Active and heat power
143+
Permissible head line: ``time,p,h``
148144
* - pqh
149-
- | Active, reactive and heat power
150-
| Permissible head line: ``time,p,q,h``
145+
- Active, reactive and heat power
146+
Permissible head line: ``time,p,q,h``
151147
* - weather
152-
- | Weather information
153-
| Permissible head line: ``time,coordinate,direct_irradiation,diffuse_irradiation,temperature,wind_velocity,wind_direction``
148+
- Weather information
149+
Permissible head line: ``time,coordinate,direct_irradiation,diffuse_irradiation,temperature,wind_velocity,wind_direction``
154150
155151
```
156152

157153
### Results
158154

159-
```{eval-rst}
160-
.. list-table::
155+
```{list-table}
161156
:widths: auto
162157
:header-rows: 1
163158

‎docs/readthedocs/models/input/additionaldata/idcoordinatesource.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ coordinates.
77

88
## Information
99

10-
```{eval-rst}
11-
.. list-table::
12-
:widths: 33 33
10+
```{list-table}
11+
:widths: auto
12+
:class: wrapping
1313
:header-rows: 1
1414
1515
* - Attribute

‎docs/readthedocs/models/input/additionaldata/timeseries.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ In addition to actual data, a mapping function has to be known.
1717
To be as flexible, as possible, the actual content of the time series is given as children of the `Value` class.
1818
The following different values are available:
1919

20-
```{eval-rst}
21-
.. list-table::
22-
:widths: 33 33
20+
```{list-table}
21+
:widths: auto
22+
:class: wrapping
2323
:header-rows: 1
2424
2525
* - Value Class

‎docs/readthedocs/models/input/em.md‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,40 +7,40 @@ Participants are connected to an EM each via their `em` field.
77

88
## Attributes, Units and Remarks
99

10-
```{eval-rst}
11-
.. list-table::
12-
:widths: 33 33 33
10+
```{list-table}
11+
:widths: auto
1312
:header-rows: 1
13+
:class: wrapping
1414
1515
1616
* - Attribute
1717
- Unit
1818
- Remarks
1919
2020
* - uuid
21-
- --
22-
-
21+
-
22+
-
2323
2424
* - id
25-
- --
25+
-
2626
- Human readable identifier
2727
2828
* - operator
29-
- --
30-
-
29+
-
30+
-
3131
3232
* - operationTime
33-
- --
33+
-
3434
- Timely restriction of operation
3535
3636
* - controlStrategy
37-
- --
37+
-
3838
- String representation (e.g. name) of a control strategy
3939
4040
* - parentEm
41-
- --
42-
- | Reference to a superior Energy Management Unit that is controlling this EM.
43-
| Field can be empty or missing, if this EM itself is not controlled.
41+
-
42+
- Reference to a superior Energy Management Unit that is controlling this EM.
43+
Field can be empty or missing, if this EM itself is not controlled.
4444
4545
```
4646

‎docs/readthedocs/models/input/grid/gridcontainer.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,9 @@ A synoptic overview of both classes' attributes is given here:
3737

3838
## Attributes, Units and Remarks
3939

40-
```{eval-rst}
41-
.. list-table::
42-
:widths: 33 33 33
40+
```{list-table}
41+
:widths: auto
42+
:class: wrapping
4343
:header-rows: 1
4444
4545

‎docs/readthedocs/models/input/grid/line.md‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ Representation of an AC line.
66

77
### Type Model
88

9-
```{eval-rst}
10-
.. list-table::
11-
:widths: 33 33 33
9+
```{list-table}
10+
:widths: auto
11+
:class: wrapping
1212
:header-rows: 1
1313
1414
* - Attribute
@@ -53,9 +53,9 @@ A list with some standard line types can be found here: [Standard Line Types](#s
5353

5454
### Entity Model
5555

56-
```{eval-rst}
57-
.. list-table::
58-
:widths: 33 33 33
56+
```{list-table}
57+
:widths: auto
58+
:class: wrapping
5959
:header-rows: 1
6060
6161
@@ -89,9 +89,9 @@ A list with some standard line types can be found here: [Standard Line Types](#s
8989
9090
* - parallelDevices
9191
- –
92-
- | overall amount of parallel lines to automatically construct
93-
| (e.g. parallelDevices = 2 will build a total of two lines
94-
| using the specified parameters)
92+
- overall amount of parallel lines to automatically construct
93+
(e.g. parallelDevices = 2 will build a total of two lines
94+
using the specified parameters)
9595
9696
* - type
9797
- –
@@ -108,9 +108,9 @@ A list with some standard line types can be found here: [Standard Line Types](#s
108108
109109
* - olmCharacteristic
110110
- –
111-
- | Characteristic of possible overhead line monitoring Can be
112-
| given in the form of ``olm:{<List of Pairs>}``. The pairs
113-
| are wind velocity in x and permissible loading in y.
111+
- Characteristic of possible overhead line monitoring Can be
112+
given in the form of ``olm:{<List of Pairs>}``. The pairs
113+
are wind velocity in x and permissible loading in y.
114114
115115
```
116116

@@ -126,9 +126,9 @@ The lines which source is ``simBench`` are from [here](https://simbench.de/en/do
126126

127127
Some standard overhead lines.
128128

129-
```{eval-rst}
130-
.. list-table::
131-
:widths: 11 11 11 11 11 11 11 11 11
129+
```{list-table}
130+
:widths: auto
131+
:class: wrapping
132132
:header-rows: 1
133133
134134
@@ -309,9 +309,9 @@ Some standard overhead lines.
309309

310310
Some standard cables.
311311

312-
```{eval-rst}
313-
.. list-table::
314-
:widths: 11 11 11 11 11 11 11 11 11
312+
```{list-table}
313+
:widths: auto
314+
:class: wrapping
315315
:header-rows: 1
316316
317317

0 commit comments

Comments
 (0)