added reference to env.rst in index.rst

infer-actively · Mar 13, 2022 · ea83bca · ea83bca
1 parent 01b75dc
commit ea83bca
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 1 deletion.
diff --git a/docs/env.rst b/docs/env.rst
@@ -0,0 +1,24 @@
+Env
+========
+
+The OpenAIGym-inspired ``Env`` base class is the main API that represents the environmental dynamics or "generative process" with
+which agents exchange observations and actions
+
+Base class
+----------
+.. autoclass:: pymdp.envs.Env
+
+Specific environment implementations
+----------
+
+All of the following dynamics inherit from ``Env`` and have the
+same general usage as above.
+
+.. autosummary::
+   :nosignatures:
+
+    pymdp.envs.GridWorldEnv
+    pymdp.envs.DGridWorldEnv
+    pymdp.envs.VisualForagingEnv
+    pymdp.envs.TMazeEnv
+    pymdp.envs.TMazeEnvNullOutcome
diff --git a/docs/index.rst b/docs/index.rst
@@ -42,7 +42,7 @@ specificity to a given task.
    :caption: Agent and environment API
 
    agent
-   env/index
+   env
 
 Indices and tables
 ==================