adressing issue rte-france#184 by adding a page of the documentation …

…were available env are described
BDonnot · Apr 12, 2021 · 439e881 · 439e881
1 parent ee1bce5
commit 439e881
Show file tree

Hide file tree

Showing 8 changed files with 355 additions and 5 deletions.
diff --git a/.gitignore b/.gitignore
@@ -302,6 +302,7 @@ invert_idto_act.py
 test_bug_discord1.py
 test_networkx.py
 test_issue185.py
+test_can_make_opponent.py
 
 # profiling files
 **.prof
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -33,8 +33,11 @@ Change Log
 - [ADDED] a feature to retrieve the voltage angle (theta) in the backend (`backend.get_theta`) and in the observation.
 - [ADDED] support for multimix in the GymEnv (lack of support spotted thanks to
   `Issue #185 <https://github.com/rte-france/Grid2Op/issues/185>`_ )
+- [ADDED] basic documentation of the environment available.
 - [IMPROVED] extra layer of security preventing modification of `observation_space` and `action_space` of environment
 - [IMPROVED] better handling of dynamically generated classes
+- [IMPROVED] the documentation of the opponent
+
 
 [1.5.0] - 2021-03-31
 -------------------------

diff --git a/docs/available_envs.rst b/docs/available_envs.rst
diff --git a/docs/img/R2_full_grid.png b/docs/img/R2_full_grid.png
diff --git a/docs/img/l2rpn_case14_sandbox_layout.png b/docs/img/l2rpn_case14_sandbox_layout.png
diff --git a/docs/img/l2rpn_neurips_2020_track1_layout.png b/docs/img/l2rpn_neurips_2020_track1_layout.png
diff --git a/docs/img/l2rpn_neurips_2020_track2_layout.png b/docs/img/l2rpn_neurips_2020_track2_layout.png
diff --git a/docs/opponent.rst b/docs/opponent.rst
@@ -161,7 +161,7 @@ To summarize what is going on here:
 Detailed Documentation by class
 --------------------------------
 .. automodule:: grid2op.Opponent
-   :members:
+    :members:
     :autosummary:
 
 .. include:: final.rst