Skip to content

Commit e1a03ad

Browse files
Fixing sphinx warnings
1 parent dc897c2 commit e1a03ad

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

docs/readthedocs/models/models.rst

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Immutability
2424
Copyable
2525
With the general design principle of immutability, entity modifications (e.g. updates of field values) can become
2626
hard and annoying. To avoid generating methods to update each field value, we provide an adapted version of the
27-
`builder pattern <https://en.wikipedia.org/wiki/Builder_pattern/>`_ to make entity modifications as easy as possible.
27+
`builder pattern <https://en.wikipedia.org/wiki/Builder_pattern/>`__ to make entity modifications as easy as possible.
2828
Each entity holds it's own copy builder class, which follows the same inheritance as the entity class itself. With a
2929
call of `.copy()` on an entity instance a builder instance is returned, that allows for modification of fields and
3030
can be terminated with `.build()` which will return an instance of the entity with modified field values as required.
@@ -50,7 +50,7 @@ Harmonized Units System
5050

5151
Equality Checks
5252
To represent quantities in the models within an acceptable accuracy, the JSR 385 reference implementation
53-
`Indriya <https://github.com/unitsofmeasurement/indriya>`_ is used. Comparing quantity objects or objects holding quantity
53+
`Indriya <https://github.com/unitsofmeasurement/indriya>`__ is used. Comparing quantity objects or objects holding quantity
5454
instances is not as trivial as it might seem, because there might be different understandings about the equality of
5555
quantities (e.g. there is a big difference between two instances being equal or equivalent). After long discussions how to
5656
treat quantities in the entity :code:`equals()` method, we agreed on the following rules to be applied:
@@ -74,12 +74,12 @@ Equality Checks
7474
would return :code:`false` as the equality check does NOT convert units. If you want to compare two entity instances
7575
based on their equivalence you have (for now) check for each quantity manually using their :code:`isEquivalentTo()`
7676
method. If you think you would benefit from a standard method that allows entity equivalence check, please consider
77-
handing in an issue `here <https://github.com/ie3-institute/PowerSystemDataModel/issues>`_.
77+
handing in an issue `here <https://github.com/ie3-institute/PowerSystemDataModel/issues>`__.
7878
Furthermore, the current existing implementation of :code:`isEquivalentTo()` in indriya does not allow the provision of
7979
a tolerance threshold that might be necessary when comparing values from floating point operations. We consider
80-
providing such a method in our `PowerSystemUtils <https://github.com/ie3-institute/PowerSystemUtils>`_ library.
80+
providing such a method in our `PowerSystemUtils <https://github.com/ie3-institute/PowerSystemUtils>`__ library.
8181
If you think you would benefit from such a method, please consider handing in an issue
82-
`here <https://github.com/ie3-institute/PowerSystemUtils/issues>`_.
82+
`here <https://github.com/ie3-institute/PowerSystemUtils/issues>`__.
8383

8484
Conditional Parameters
8585
Some of the models have conditional parameters. When reading model data from a data source, their respective factories for building these
@@ -97,8 +97,8 @@ Model classes you can use to describe a data set as input to power system simula
9797

9898
input/operator
9999

100-
Grid Related Models
101-
===================
100+
Grid Related Input Models
101+
=========================
102102
.. toctree::
103103
:maxdepth: 1
104104

@@ -112,8 +112,8 @@ Grid Related Models
112112
input/grid/measurementunit
113113
input/grid/gridcontainer
114114

115-
Participant Related Models
116-
==========================
115+
Participant Related Input Models
116+
================================
117117
.. toctree::
118118
:maxdepth: 1
119119

@@ -137,8 +137,8 @@ Result
137137
******
138138
Model classes you can use to describe the outcome of a power system simulation.
139139

140-
Grid Related Models
141-
===================
140+
Grid Related Result Models
141+
==========================
142142
.. toctree::
143143
:maxdepth: 1
144144

@@ -150,8 +150,8 @@ Grid Related Models
150150
result/grid/transformer2w
151151
result/grid/transformer3w
152152

153-
Participant Related Models
154-
==========================
153+
Participant Related Result Models
154+
=================================
155155
.. toctree::
156156
:maxdepth: 1
157157

0 commit comments

Comments
 (0)