Add VectorizeMode for make_vec

.github/workflows/build-docs.yml

@@ -1,15 +1,19 @@
 name: Build main branch documentation website
+
 on:
   push:
     branches: [main]
+
 permissions:
   contents: write
+
 jobs:
   docs:
     name: Generate Website
     runs-on: ubuntu-latest
     env:
       SPHINX_GITHUB_CHANGELOG_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
     steps:
       - uses: actions/checkout@v3
 

.github/workflows/build.yml

@@ -32,4 +32,4 @@ jobs:
              --tag gymnasium-necessary-docker .
       - name: Run tests
         run: |
-           docker run gymnasium-necessary-docker pytest tests/test_core.py tests/envs/test_compatibility.py tests/envs/test_envs.py tests/spaces
+           docker run gymnasium-necessary-docker pytest tests/test_core.py tests/envs/test_envs.py tests/spaces

.github/workflows/docs-manual-versioning.yml

@@ -1,4 +1,5 @@
 name: Manual Docs Versioning
+
 on:
   workflow_dispatch:
     inputs:
@@ -14,6 +15,7 @@ on:
 
 permissions:
   contents: write
+
 jobs:
   docs:
     name: Generate Website for new version

.github/workflows/docs-versioning.yml

@@ -1,10 +1,13 @@
 name: Docs Versioning
+
 on:
   push:
     tags:
       - 'v?*.*.*'
+      -
 permissions:
   contents: write
+
 jobs:
   docs:
     name: Generate Website for new version

.pre-commit-config.yaml

@@ -51,7 +51,7 @@ repos:
     rev: 6.3.0
     hooks:
       - id: pydocstyle
-        exclude: ^(gymnasium/envs/box2d)|(gymnasium/envs/classic_control)|(gymnasium/envs/mujoco)|(gymnasium/envs/toy_text)|(tests/envs)|(tests/spaces)|(tests/utils)|(tests/vector)|(tests/wrappers)|(docs/)
+        exclude: ^(gymnasium/envs/box2d)|(gymnasium/envs/classic_control)|(gymnasium/envs/mujoco)|(gymnasium/envs/toy_text)|(tests/envs)|(tests/spaces)|(tests/utils)|(tests/vector)|(docs/)
         args:
           - --source
           - --explain

docs/_scripts/gen_wrapper_table.py

@@ -0,0 +1,73 @@
+import os.path
+
+import gymnasium as gym
+
+
+exclude_wrappers = {"vector"}
+
+
+def generate_wrappers():
+    wrapper_table = ""
+    for wrapper_name in sorted(gym.wrappers.__all__):
+        if wrapper_name not in exclude_wrappers:
+            wrapper_doc = getattr(gym.wrappers, wrapper_name).__doc__.split("\n")[0]
+            wrapper_table += f"""    * - :class:`{wrapper_name}`
+      - {wrapper_doc}
+"""
+    return wrapper_table
+
+
+def generate_vector_wrappers():
+    unique_vector_wrappers = set(gym.wrappers.vector.__all__) - set(
+        gym.wrappers.__all__
+    )
+
+    vector_table = ""
+    for vector_name in sorted(unique_vector_wrappers):
+        vector_doc = getattr(gym.wrappers.vector, vector_name).__doc__.split("\n")[0]
+        vector_table += f"""    * - :class:`{vector_name}`
+      - {vector_doc}
+"""
+    return vector_table
+
+
+if __name__ == "__main__":
+    gen_wrapper_table = generate_wrappers()
+    gen_vector_table = generate_vector_wrappers()
+
+    page = f"""
+# List of Gymnasium Wrappers
+
+Gymnasium provides a number of commonly used wrappers listed below. More information can be found on the particular
+wrapper in the page on the wrapper type
+
+```{{eval-rst}}
+.. py:currentmodule:: gymnasium.wrappers
+
+.. list-table::
+    :header-rows: 1
+
+    * - Name
+      - Description
+{gen_wrapper_table}
+```
+
+## Vector only Wrappers
+
+```{{eval-rst}}
+.. py:currentmodule:: gymnasium.wrappers.vector
+
+.. list-table::
+    :header-rows: 1
+
+    * - Name
+      - Description
+{gen_vector_table}
+```
+"""
+
+    filename = os.path.join(
+        os.path.dirname(__file__), "..", "api", "wrappers", "table.md"
+    )
+    with open(filename, "w") as file:
+        file.write(page)

docs/api/env.md

@@ -1,29 +1,26 @@
 ---
-title: Utils
+title: Env
 ---
 
 # Env
 
-## gymnasium.Env
-
 ```{eval-rst}
 .. autoclass:: gymnasium.Env
 ```
 
-### Methods
-
+## Methods
 ```{eval-rst}
-.. autofunction:: gymnasium.Env.step
-.. autofunction:: gymnasium.Env.reset
-.. autofunction:: gymnasium.Env.render
+.. automethod:: gymnasium.Env.step
+.. automethod:: gymnasium.Env.reset
+.. automethod:: gymnasium.Env.render
+.. automethod:: gymnasium.Env.close
 ```
 
-### Attributes
-
+## Attributes
 ```{eval-rst}
 .. autoattribute:: gymnasium.Env.action_space
 
-    The Space object corresponding to valid actions, all valid actions should be contained with the space. For example, if the action space is of type `Discrete` and gives the value `Discrete(2)`, this means there are two valid discrete actions: 0 & 1.
+    The Space object corresponding to valid actions, all valid actions should be contained with the space. For example, if the action space is of type `Discrete` and gives the value `Discrete(2)`, this means there are two valid discrete actions: `0` & `1`.
 
     .. code::
 
@@ -51,29 +48,26 @@ title: Utils
 
     The render mode of the environment determined at initialisation
 
-.. autoattribute:: gymnasium.Env.reward_range
-
-    A tuple corresponding to the minimum and maximum possible rewards for an agent over an episode. The default reward range is set to :math:`(-\infty,+\infty)`.
-
 .. autoattribute:: gymnasium.Env.spec
 
-    The ``EnvSpec`` of the environment normally set during :py:meth:`gymnasium.make`
+    The :class:`EnvSpec` of the environment normally set during :py:meth:`gymnasium.make`
+
+.. autoproperty:: gymnasium.Env.unwrapped
+.. autoproperty:: gymnasium.Env.np_random
 ```
 
-### Additional Methods
+## Implementing environments
 
 ```{eval-rst}
-.. autofunction:: gymnasium.Env.close
-.. autoproperty:: gymnasium.Env.unwrapped
-.. autoproperty:: gymnasium.Env.np_random
+.. py:currentmodule:: gymnasium
+
+When implementing an environment, the :meth:`Env.reset` and :meth:`Env.step` functions much be created describing the dynamics of the environment. For more information see the environment creation tutorial.
 ```
 
-### Implementing environments
+## Creating environments
 
 ```{eval-rst}
 .. py:currentmodule:: gymnasium
 
-When implementing an environment, the :meth:`Env.reset` and :meth:`Env.step` functions much be created describing the
-dynamics of the environment.
-For more information see the environment creation tutorial.
+To create an environment, gymnasium provides :meth:`make` to initialise the environment along with several important wrappers. Furthermore, gymnasium provides :meth:`make_vec` for creating vector environments and to view all the environment that can be created use :meth:`pprint_registry`.
 ```