update documentation

robinhenry · Nov 13, 2024 · ad96ff2 · ad96ff2
1 parent 050d4e4
commit ad96ff2
Show file tree

Hide file tree

Showing 10 changed files with 14 additions and 339 deletions.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -38,7 +38,7 @@ Key features
 ------------
 *  Very little background in electricity systems modelling is required. This makes :code:`gym-anm` an ideal starting point
    for RL students and researchers looking to enter the field.
-*  The environments (tasks) generated by :code:`gym-anm` follow the `OpenAI Gym <https://github.com/openai/gym>`_
+*  The environments (tasks) generated by :code:`gym-anm` follow the `Gymnasium <https://gymnasium.farama.org/>`_
    framework, with which a large part of the RL community is already familiar.
 *  The flexibility of :code:`gym-anm`, with its different customizable components, makes it a suitable framework
    to model a wide range of ANM tasks, from simple ones that can be used for educational purposes, to complex ones

diff --git a/docs/source/topics/about.rst b/docs/source/topics/about.rst
@@ -4,7 +4,5 @@ About
 =====
 
 The design of :code:`gym-anm` started as a summer undergraduate project conducted by
-`Robin Henry <https://www.robinxhenry.com/>`_ at the University of Liège (ULiège), Belgium, under the supervision of
+`Robin Henry <https://www.linkedin.com/in/rhenry012/>`_ at the University of Liège (ULiège), Belgium, under the supervision of
 `Prof. Damien Ernst <http://blogs.ulg.ac.be/damien-ernst/>`_ in 2019.
-
-It remained a side project until its first version was released in March 2021.
diff --git a/docs/source/topics/archive/action_space.rst b/docs/source/topics/archive/action_space.rst
diff --git a/docs/source/topics/archive/background.rst b/docs/source/topics/archive/background.rst
diff --git a/docs/source/topics/archive/rewards.rst b/docs/source/topics/archive/rewards.rst
diff --git a/docs/source/topics/archive/state_space.rst b/docs/source/topics/archive/state_space.rst
diff --git a/docs/source/topics/archive/task_overview.rst b/docs/source/topics/archive/task_overview.rst
diff --git a/docs/source/topics/design_new_env.rst b/docs/source/topics/design_new_env.rst
@@ -45,7 +45,7 @@ where:
   way to infer the bounds of observation vectors :math:`o_t` and :code:`observation_bounds()` can be used
   to specify them.
 * :code:`render()` and :code:`close()` are optional methods that can be implemented to support rendering
-  of the environment. For more information, see the official `Gym <https://gym.openai.com/docs/>`_ documentation.
+  of the environment. For more information, see the official `Gymnasium <https://gymnasium.farama.org/>`_ documentation.
 
 
 Example