add new docs to index, fixed table, rename img ext

assume-framework · Oct 23, 2023 · 7b04e2f · 7b04e2f
1 parent 083aedd
commit 7b04e2f
Show file tree

Hide file tree

Showing 7 changed files with 15 additions and 37 deletions.
diff --git a/docs/source/assume.strategies.rst b/docs/source/assume.strategies.rst
@@ -44,13 +44,6 @@ assume.strategies.naive\_strategies module
    :undoc-members:
    :show-inheritance:
 
-assume.strategies.storage\_strategies module
---------------------------------------------
-
-.. automodule:: assume.strategies.storage_strategies
-   :members:
-   :undoc-members:
-   :show-inheritance:
 
 Module contents
 ---------------

diff --git a/docs/source/assume.units.rst b/docs/source/assume.units.rst
@@ -12,22 +12,6 @@ assume.units.demand module
    :undoc-members:
    :show-inheritance:
 
-assume.units.electrolyser module
---------------------------------
-
-.. automodule:: assume.units.electrolyser
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-assume.units.heatpump module
-----------------------------
-
-.. automodule:: assume.units.heatpump
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
 assume.units.powerplant module
 ------------------------------
 

diff --git a/docs/source/example_simulations.rst b/docs/source/example_simulations.rst
@@ -7,18 +7,15 @@ Here you can find an overview of the different exampels provided.
 
 
 
-  ============================ ============================= =====================================================
-  example name                 input files                  description
  ============================= ============================= =====================================================
-    small                       example_01a                   The dimension of the observations given to the actor in the bidding strategy.
-    small_dam                   example_01a                   The dimension of the observations given to the actor in the bidding strategy.
-    small_with_opt_clearing     example_01a                   The dimension of the observations given to the actor in the bidding strategy.
-    small_with_BB               example_01e                   The dimension of the actors made by the actor, which equals the output neurons of the actor neuronal net.
-    small_with_vre              example_01b                   Whether to use pre-learned strategies and then continue learning.
-                                example_01c                         If pre-learned strategies should be used, where are they stored.
-
- ...
-
-    learning_small              example_02a                   A small study with roughly 10 powerplants, where one powerplant is equiped with a learning bidding strategy and can learn to exert market power.
-    learning_medium             example_02b                   A small study with roughly 10 powerplants, where multiple powerplants are equiped with a learning bidding strategy and learn that they do not have market power anymore.
-  ============================= =====================================================
+  example name                 input files                   description
+ ============================= ============================= =====================================================
+  small                         example_01a                     The dimension of the observations given to the actor in the bidding strategy.
+  small_dam                     example_01a                     The dimension of the observations given to the actor in the bidding strategy.
+  small_with_opt_clearing       example_01a                     The dimension of the observations given to the actor in the bidding strategy.
+  small_with_BB                 example_01e                     The dimension of the actors made by the actor, which equals the output neurons of the actor neuronal net.
+  small_with_vre                example_01b                     Whether to use pre-learned strategies and then continue learning.
+                                example_01c                     If pre-learned strategies should be used, where are they stored.
+  learning_small                example_02a                     A small study with roughly 10 powerplants, where one powerplant is equiped with a learning bidding strategy and can learn to exert market power.
+  learning_medium               example_02b                     A small study with roughly 10 powerplants, where multiple powerplants are equiped with a learning bidding strategy and learn that they do not have market power anymore.
+ ============================= ============================= =====================================================
diff --git a/docs/source/img/ActorOutput.JPG → docs/source/img/ActorOutput.jpg b/docs/source/img/ActorOutput.JPG → docs/source/img/ActorOutput.jpg
diff --git a/docs/source/img/ActorTask.JPG → docs/source/img/ActorTask.jpg b/docs/source/img/ActorTask.JPG → docs/source/img/ActorTask.jpg
diff --git a/docs/source/img/CriticTask.JPG → docs/source/img/CriticTask.jpg b/docs/source/img/CriticTask.JPG → docs/source/img/CriticTask.jpg
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -45,6 +45,8 @@ Documentation
 * :doc:`market_config`
 * :doc:`market_mechanism`
 * :doc:`bidding_agents`
+* :doc:`learning`
+* :doc:`example_simulations`
 * :doc:`assume`
 
 .. toctree::
@@ -58,6 +60,8 @@ Documentation
    market_config
    market_mechanism
    bidding_agents
+   example_simulations
+   learning
    assume
 
 Indices and tables