docs: improve documentation and package.json (#331)

rickstaa · Aug 14, 2023 · e9fb90e · e9fb90e
1 parent f60cc3b
commit e9fb90e
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 6 deletions.
diff --git a/docs/source/usage/running.rst b/docs/source/usage/running.rst
@@ -466,8 +466,8 @@ can be done by adding the following lines to your environment file:
 
 .. code-block:: python
 
-    import gym
-    from gym.envs.registration import register
+    import gymnasium as gym
+    from gymnasium.envs.registration import register
 
     register(
         id='CustomEnv-v0',
@@ -499,7 +499,7 @@ to set up specialized custom experiments, for example:
 
     from stable_learning_control.control import sac_tf2 as sac
     import tensorflow as tf
-    import gym
+    import gymnasium as gym
 
     env_fn = lambda : gym.make('LunarLander-v2')
 

diff --git a/docs/source/usage/saving_and_loading.rst b/docs/source/usage/saving_and_loading.rst
@@ -182,7 +182,7 @@ or :ref:`load_tf2_policy` documentation below to load the policy in a Python scr
 
 .. code-block::
 
-    >>> import gym
+    >>> import gymnasium as gym
     >>> from stable_learning_control.utils.test_policy import load_pytorch_policy, run_policy
     >>> import your_env
     >>> env = gym.make('<YOUR_ENV_NAME>')

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -10,6 +10,9 @@
     "simulation",
     "openai-gym",
     "gymnasium",
+    "gymnasium-environments",
+    "gym",
+    "gym-environments",
     "artificial-intelligence",
     "deep-learning",
     "neural-networks",