Merge pull request #736 from ie3-institute/sp/#735-sphinx-dependabot

Add readthedocs python dependencies to dependabot.yml

Author: danielfeismann

.github/dependabot.yml

@@ -12,7 +12,16 @@ updates:
   - sensarmad
   - sebastian-peter
   - danielfeismann
+  - jo-bao
   ignore:
   - dependency-name: org.spockframework:spock-core
     versions:
         - 2.3-groovy-4.0
+
+- package-ecosystem: pip
+  directory: "/docs/readthedocs"
+  schedule:
+    interval: daily
+    time: "04:00"
+  open-pull-requests-limit: 8
+  target-branch: dev

CHANGELOG.md

@@ -17,6 +17,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - `ThermalGrid` as a container for a completely connected thermal grid
 - `EmResult` and `FlexOptionsResult` for Energy Management Systems [#651](https://github.com/ie3-institute/PowerSystemDataModel/issues/651)
 - `EvcsInput` now has a parameter for enabling and disabling vehicle to grid support [#681](https://github.com/ie3-institute/PowerSystemDataModel/issues/681)
+- Added Dependabot updates to sphinx/readthedocs dependencies [#735](https://github.com/ie3-institute/PowerSystemDataModel/issues/735)
 
 ### Fixed
 - Reduced code smells [#492](https://github.com/ie3-institute/PowerSystemDataModel/issues/492)

docs/readthedocs/index.rst

@@ -19,8 +19,11 @@ Contact the (Main) Maintainers
 If you feel, something this missing, wrong or misleading, please contact one of our main contributors:
 
    * `@sensarmad <https://github.com/sensarmad>`_
-   * `@johanneshiry <https://github.com/johanneshiry>`_
-   * `@ckittl <https://github.com/ckittl>`_
+   * `@t-ober <https://github.com/t-ober>`_
+   * `@danielfeismann <https://github.com/danielfeismann>`_
+   * `@sebastian-peter <https://github.com/sebastian-peter>`_
+   * `@jo-bao <https://github.com/jo-bao>`_
+   * `@julianhohmann <https://github.com/julianhohmann>`_
 
 Hat tip to all other contributors!
 

docs/readthedocs/models/models.rst

@@ -24,7 +24,7 @@ Immutability
 Copyable
   With the general design principle of immutability, entity modifications (e.g. updates of field values) can become
   hard and annoying. To avoid generating methods to update each field value, we provide an adapted version of the
-  `builder pattern <https://en.wikipedia.org/wiki/Builder_pattern/>`_ to make entity modifications as easy as possible.
+  `builder pattern <https://en.wikipedia.org/wiki/Builder_pattern/>`__ to make entity modifications as easy as possible.
   Each entity holds it's own copy builder class, which follows the same inheritance as the entity class itself. With a
   call of `.copy()` on an entity instance a builder instance is returned, that allows for modification of fields and
   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
 
 Equality Checks
   To represent quantities in the models within an acceptable accuracy, the JSR 385 reference implementation
-  `Indriya <https://github.com/unitsofmeasurement/indriya>`_ is used. Comparing quantity objects or objects holding quantity
+  `Indriya <https://github.com/unitsofmeasurement/indriya>`__ is used. Comparing quantity objects or objects holding quantity
   instances is not as trivial as it might seem, because there might be different understandings about the equality of
   quantities (e.g. there is a big difference between two instances being equal or equivalent). After long discussions how to
   treat quantities in the entity :code:`equals()` method, we agreed on the following rules to be applied:
@@ -74,12 +74,12 @@ Equality Checks
     would return :code:`false` as the equality check does NOT convert units. If you want to compare two entity instances
     based on their equivalence you have (for now) check for each quantity manually using their :code:`isEquivalentTo()`
     method. If you think you would benefit from a standard method that allows entity equivalence check, please consider
-    handing in an issue `here <https://github.com/ie3-institute/PowerSystemDataModel/issues>`_.
+    handing in an issue `here <https://github.com/ie3-institute/PowerSystemDataModel/issues>`__.
     Furthermore, the current existing implementation of :code:`isEquivalentTo()` in indriya does not allow the provision of
     a tolerance threshold that might be necessary when comparing values from floating point operations. We consider
-    providing such a method in our `PowerSystemUtils <https://github.com/ie3-institute/PowerSystemUtils>`_ library.
+    providing such a method in our `PowerSystemUtils <https://github.com/ie3-institute/PowerSystemUtils>`__ library.
     If you think you would benefit from such a method, please consider handing in an issue
-    `here <https://github.com/ie3-institute/PowerSystemUtils/issues>`_.
+    `here <https://github.com/ie3-institute/PowerSystemUtils/issues>`__.
 
 Conditional Parameters
   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
 
    input/operator
 
-Grid Related Models
-===================
+Grid Related Input Models
+=========================
 .. toctree::
    :maxdepth: 1
 
@@ -112,8 +112,8 @@ Grid Related Models
    input/grid/measurementunit
    input/grid/gridcontainer
 
-Participant Related Models
-==========================
+Participant Related Input Models
+================================
 .. toctree::
    :maxdepth: 1
 
@@ -137,8 +137,8 @@ Result
 ******
 Model classes you can use to describe the outcome of a power system simulation.
 
-Grid Related Models
-===================
+Grid Related Result Models
+==========================
 .. toctree::
    :maxdepth: 1
 
@@ -150,8 +150,8 @@ Grid Related Models
    result/grid/transformer2w
    result/grid/transformer3w
 
-Participant Related Models
-==========================
+Participant Related Result Models
+=================================
 .. toctree::
    :maxdepth: 1
 

docs/readthedocs/requirements.txt

@@ -1,4 +1,4 @@
 commonmark==0.9.1
 recommonmark==0.7.1
-Sphinx==4.2.0
-sphinx-rtd-theme==1.0.0
+Sphinx==5.3.0
+sphinx-rtd-theme==1.1.1