Docs update (#46)

* docs update * docs
h2r · Jan 26, 2024 · a177c78 · a177c78
1 parent 36edc64
commit a177c78
Show file tree

Hide file tree

Showing 292 changed files with 19,061 additions and 36,177 deletions.
diff --git a/docs/_sphinx_src/api/pomdp_py.problems.lasertag.rst b/docs/_sphinx_src/api/pomdp_py.problems.lasertag.rst
@@ -0,0 +1,10 @@
+pomdp\_py.problems.lasertag package
+===================================
+
+Module contents
+---------------
+
+.. automodule:: pomdp_py.problems.lasertag
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sphinx_src/api/pomdp_py.problems.light_dark.agent.rst b/docs/_sphinx_src/api/pomdp_py.problems.light_dark.agent.rst
@@ -0,0 +1,21 @@
+pomdp\_py.problems.light\_dark.agent package
+============================================
+
+Submodules
+----------
+
+pomdp\_py.problems.light\_dark.agent.belief module
+--------------------------------------------------
+
+.. automodule:: pomdp_py.problems.light_dark.agent.belief
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: pomdp_py.problems.light_dark.agent
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sphinx_src/api/pomdp_py.problems.light_dark.domain.rst b/docs/_sphinx_src/api/pomdp_py.problems.light_dark.domain.rst
@@ -0,0 +1,37 @@
+pomdp\_py.problems.light\_dark.domain package
+=============================================
+
+Submodules
+----------
+
+pomdp\_py.problems.light\_dark.domain.action module
+---------------------------------------------------
+
+.. automodule:: pomdp_py.problems.light_dark.domain.action
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pomdp\_py.problems.light\_dark.domain.observation module
+--------------------------------------------------------
+
+.. automodule:: pomdp_py.problems.light_dark.domain.observation
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pomdp\_py.problems.light\_dark.domain.state module
+--------------------------------------------------
+
+.. automodule:: pomdp_py.problems.light_dark.domain.state
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: pomdp_py.problems.light_dark.domain
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sphinx_src/api/pomdp_py.problems.light_dark.env.rst b/docs/_sphinx_src/api/pomdp_py.problems.light_dark.env.rst
@@ -0,0 +1,37 @@
+pomdp\_py.problems.light\_dark.env package
+==========================================
+
+Submodules
+----------
+
+pomdp\_py.problems.light\_dark.env.env module
+---------------------------------------------
+
+.. automodule:: pomdp_py.problems.light_dark.env.env
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pomdp\_py.problems.light\_dark.env.plotting module
+--------------------------------------------------
+
+.. automodule:: pomdp_py.problems.light_dark.env.plotting
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pomdp\_py.problems.light\_dark.env.visual module
+------------------------------------------------
+
+.. automodule:: pomdp_py.problems.light_dark.env.visual
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: pomdp_py.problems.light_dark.env
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sphinx_src/api/pomdp_py.problems.light_dark.models.rst b/docs/_sphinx_src/api/pomdp_py.problems.light_dark.models.rst
@@ -0,0 +1,29 @@
+pomdp\_py.problems.light\_dark.models package
+=============================================
+
+Submodules
+----------
+
+pomdp\_py.problems.light\_dark.models.observation\_model module
+---------------------------------------------------------------
+
+.. automodule:: pomdp_py.problems.light_dark.models.observation_model
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pomdp\_py.problems.light\_dark.models.transition\_model module
+--------------------------------------------------------------
+
+.. automodule:: pomdp_py.problems.light_dark.models.transition_model
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: pomdp_py.problems.light_dark.models
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sphinx_src/api/pomdp_py.problems.light_dark.rst b/docs/_sphinx_src/api/pomdp_py.problems.light_dark.rst
@@ -0,0 +1,40 @@
+pomdp\_py.problems.light\_dark package
+======================================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   pomdp_py.problems.light_dark.agent
+   pomdp_py.problems.light_dark.domain
+   pomdp_py.problems.light_dark.env
+   pomdp_py.problems.light_dark.models
+
+Submodules
+----------
+
+pomdp\_py.problems.light\_dark.problem\_discrete module
+-------------------------------------------------------
+
+.. automodule:: pomdp_py.problems.light_dark.problem_discrete
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pomdp\_py.problems.light\_dark.test module
+------------------------------------------
+
+.. automodule:: pomdp_py.problems.light_dark.test
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: pomdp_py.problems.light_dark
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sphinx_src/api/pomdp_py.problems.load_unload.rst b/docs/_sphinx_src/api/pomdp_py.problems.load_unload.rst
@@ -0,0 +1,21 @@
+pomdp\_py.problems.load\_unload package
+=======================================
+
+Submodules
+----------
+
+pomdp\_py.problems.load\_unload.load\_unload module
+---------------------------------------------------
+
+.. automodule:: pomdp_py.problems.load_unload.load_unload
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: pomdp_py.problems.load_unload
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sphinx_src/api/pomdp_py.problems.maze.domain.rst b/docs/_sphinx_src/api/pomdp_py.problems.maze.domain.rst
@@ -0,0 +1,37 @@
+pomdp\_py.problems.maze.domain package
+======================================
+
+Submodules
+----------
+
+pomdp\_py.problems.maze.domain.action module
+--------------------------------------------
+
+.. automodule:: pomdp_py.problems.maze.domain.action
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pomdp\_py.problems.maze.domain.observation module
+-------------------------------------------------
+
+.. automodule:: pomdp_py.problems.maze.domain.observation
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pomdp\_py.problems.maze.domain.state module
+-------------------------------------------
+
+.. automodule:: pomdp_py.problems.maze.domain.state
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: pomdp_py.problems.maze.domain
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/...problems/pomdp_problems.tag.agent.rst.txt → ...nx_src/api/pomdp_py.problems.maze.env.rst b/...problems/pomdp_problems.tag.agent.rst.txt → ...nx_src/api/pomdp_py.problems.maze.env.rst
@@ -1,22 +1,21 @@
-pomdp\_problems.tag.agent package
-=================================
+pomdp\_py.problems.maze.env package
+===================================
 
 Submodules
 ----------
 
-pomdp\_problems.tag.agent.agent module
+pomdp\_py.problems.maze.env.env module
 --------------------------------------
 
-.. automodule:: pomdp_problems.tag.agent.agent
+.. automodule:: pomdp_py.problems.maze.env.env
    :members:
    :undoc-members:
    :show-inheritance:
 
-
 Module contents
 ---------------
 
-.. automodule:: pomdp_problems.tag.agent
+.. automodule:: pomdp_py.problems.maze.env
    :members:
    :undoc-members:
    :show-inheritance:
diff --git a/docs/_sphinx_src/api/pomdp_py.problems.maze.models.components.rst b/docs/_sphinx_src/api/pomdp_py.problems.maze.models.components.rst
@@ -0,0 +1,21 @@
+pomdp\_py.problems.maze.models.components package
+=================================================
+
+Submodules
+----------
+
+pomdp\_py.problems.maze.models.components.map module
+----------------------------------------------------
+
+.. automodule:: pomdp_py.problems.maze.models.components.map
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: pomdp_py.problems.maze.models.components
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sphinx_src/api/pomdp_py.problems.maze.models.rst b/docs/_sphinx_src/api/pomdp_py.problems.maze.models.rst
@@ -0,0 +1,18 @@
+pomdp\_py.problems.maze.models package
+======================================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   pomdp_py.problems.maze.models.components
+
+Module contents
+---------------
+
+.. automodule:: pomdp_py.problems.maze.models
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sphinx_src/api/pomdp_py.problems.maze.rst b/docs/_sphinx_src/api/pomdp_py.problems.maze.rst
@@ -0,0 +1,20 @@
+pomdp\_py.problems.maze package
+===============================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   pomdp_py.problems.maze.domain
+   pomdp_py.problems.maze.env
+   pomdp_py.problems.maze.models
+
+Module contents
+---------------
+
+.. automodule:: pomdp_py.problems.maze
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sphinx_src/api/pomdp_py.problems.multi_object_search.agent.rst b/docs/_sphinx_src/api/pomdp_py.problems.multi_object_search.agent.rst
@@ -0,0 +1,29 @@
+pomdp\_py.problems.multi\_object\_search.agent package
+======================================================
+
+Submodules
+----------
+
+pomdp\_py.problems.multi\_object\_search.agent.agent module
+-----------------------------------------------------------
+
+.. automodule:: pomdp_py.problems.multi_object_search.agent.agent
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pomdp\_py.problems.multi\_object\_search.agent.belief module
+------------------------------------------------------------
+
+.. automodule:: pomdp_py.problems.multi_object_search.agent.belief
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: pomdp_py.problems.multi_object_search.agent
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sphinx_src/api/pomdp_py.problems.multi_object_search.domain.rst b/docs/_sphinx_src/api/pomdp_py.problems.multi_object_search.domain.rst
@@ -0,0 +1,37 @@
+pomdp\_py.problems.multi\_object\_search.domain package
+=======================================================
+
+Submodules
+----------
+
+pomdp\_py.problems.multi\_object\_search.domain.action module
+-------------------------------------------------------------
+
+.. automodule:: pomdp_py.problems.multi_object_search.domain.action
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pomdp\_py.problems.multi\_object\_search.domain.observation module
+------------------------------------------------------------------
+
+.. automodule:: pomdp_py.problems.multi_object_search.domain.observation
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pomdp\_py.problems.multi\_object\_search.domain.state module
+------------------------------------------------------------
+
+.. automodule:: pomdp_py.problems.multi_object_search.domain.state
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: pomdp_py.problems.multi_object_search.domain
+   :members:
+   :undoc-members:
+   :show-inheritance: