automodules and small adjustments

docs/source/code/marl_factory_grid.environment.entity.rst

@@ -0,0 +1,53 @@
+marl\_factory\_grid.environment.entity package
+==============================================
+
+Submodules
+----------
+
+marl\_factory\_grid.environment.entity.agent module
+---------------------------------------------------
+
+.. automodule:: marl_factory_grid.environment.entity.agent
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+marl\_factory\_grid.environment.entity.entity module
+----------------------------------------------------
+
+.. automodule:: marl_factory_grid.environment.entity.entity
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+marl\_factory\_grid.environment.entity.object module
+----------------------------------------------------
+
+.. automodule:: marl_factory_grid.environment.entity.object
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+marl\_factory\_grid.environment.entity.util module
+--------------------------------------------------
+
+.. automodule:: marl_factory_grid.environment.entity.util
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+marl\_factory\_grid.environment.entity.wall module
+--------------------------------------------------
+
+.. automodule:: marl_factory_grid.environment.entity.wall
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: marl_factory_grid.environment.entity
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/code/marl_factory_grid.environment.groups.rst

@@ -0,0 +1,69 @@
+marl\_factory\_grid.environment.groups package
+==============================================
+
+Submodules
+----------
+
+marl\_factory\_grid.environment.groups.agents module
+----------------------------------------------------
+
+.. automodule:: marl_factory_grid.environment.groups.agents
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+marl\_factory\_grid.environment.groups.collection module
+--------------------------------------------------------
+
+.. automodule:: marl_factory_grid.environment.groups.collection
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+marl\_factory\_grid.environment.groups.global\_entities module
+--------------------------------------------------------------
+
+.. automodule:: marl_factory_grid.environment.groups.global_entities
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+marl\_factory\_grid.environment.groups.mixins module
+----------------------------------------------------
+
+.. automodule:: marl_factory_grid.environment.groups.mixins
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+marl\_factory\_grid.environment.groups.objects module
+-----------------------------------------------------
+
+.. automodule:: marl_factory_grid.environment.groups.objects
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+marl\_factory\_grid.environment.groups.utils module
+---------------------------------------------------
+
+.. automodule:: marl_factory_grid.environment.groups.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+marl\_factory\_grid.environment.groups.walls module
+---------------------------------------------------
+
+.. automodule:: marl_factory_grid.environment.groups.walls
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: marl_factory_grid.environment.groups
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/code/marl_factory_grid.environment.rst

@@ -0,0 +1,62 @@
+marl\_factory\_grid.environment package
+=======================================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   marl_factory_grid.environment.entity
+   marl_factory_grid.environment.groups
+
+Submodules
+----------
+
+marl\_factory\_grid.environment.actions module
+----------------------------------------------
+
+.. automodule:: marl_factory_grid.environment.actions
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+marl\_factory\_grid.environment.constants module
+------------------------------------------------
+
+.. automodule:: marl_factory_grid.environment.constants
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+marl\_factory\_grid.environment.factory module
+----------------------------------------------
+
+.. automodule:: marl_factory_grid.environment.factory
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+marl\_factory\_grid.environment.rewards module
+----------------------------------------------
+
+.. automodule:: marl_factory_grid.environment.rewards
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+marl\_factory\_grid.environment.rules module
+--------------------------------------------
+
+.. automodule:: marl_factory_grid.environment.rules
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: marl_factory_grid.environment
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/code/marl_factory_grid.levels.rst

@@ -0,0 +1,10 @@
+marl\_factory\_grid.levels package
+==================================
+
+Module contents
+---------------
+
+.. automodule:: marl_factory_grid.levels
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/code/marl_factory_grid.modules.batteries.rst

@@ -0,0 +1,53 @@
+marl\_factory\_grid.modules.batteries package
+=============================================
+
+Submodules
+----------
+
+marl\_factory\_grid.modules.batteries.actions module
+----------------------------------------------------
+
+.. automodule:: marl_factory_grid.modules.batteries.actions
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+marl\_factory\_grid.modules.batteries.constants module
+------------------------------------------------------
+
+.. automodule:: marl_factory_grid.modules.batteries.constants
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+marl\_factory\_grid.modules.batteries.entitites module
+------------------------------------------------------
+
+.. automodule:: marl_factory_grid.modules.batteries.entitites
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+marl\_factory\_grid.modules.batteries.groups module
+---------------------------------------------------
+
+.. automodule:: marl_factory_grid.modules.batteries.groups
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+marl\_factory\_grid.modules.batteries.rules module
+--------------------------------------------------
+
+.. automodule:: marl_factory_grid.modules.batteries.rules
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: marl_factory_grid.modules.batteries
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/code/marl_factory_grid.modules.clean_up.rst

@@ -0,0 +1,53 @@
+marl\_factory\_grid.modules.clean\_up package
+=============================================
+
+Submodules
+----------
+
+marl\_factory\_grid.modules.clean\_up.actions module
+----------------------------------------------------
+
+.. automodule:: marl_factory_grid.modules.clean_up.actions
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+marl\_factory\_grid.modules.clean\_up.constants module
+------------------------------------------------------
+
+.. automodule:: marl_factory_grid.modules.clean_up.constants
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+marl\_factory\_grid.modules.clean\_up.entitites module
+------------------------------------------------------
+
+.. automodule:: marl_factory_grid.modules.clean_up.entitites
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+marl\_factory\_grid.modules.clean\_up.groups module
+---------------------------------------------------
+
+.. automodule:: marl_factory_grid.modules.clean_up.groups
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+marl\_factory\_grid.modules.clean\_up.rules module
+--------------------------------------------------
+
+.. automodule:: marl_factory_grid.modules.clean_up.rules
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: marl_factory_grid.modules.clean_up
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/code/marl_factory_grid.modules.destinations.rst

@@ -0,0 +1,53 @@
+marl\_factory\_grid.modules.destinations package
+================================================
+
+Submodules
+----------
+
+marl\_factory\_grid.modules.destinations.actions module
+-------------------------------------------------------
+
+.. automodule:: marl_factory_grid.modules.destinations.actions
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+marl\_factory\_grid.modules.destinations.constants module
+---------------------------------------------------------
+
+.. automodule:: marl_factory_grid.modules.destinations.constants
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+marl\_factory\_grid.modules.destinations.entitites module
+---------------------------------------------------------
+
+.. automodule:: marl_factory_grid.modules.destinations.entitites
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+marl\_factory\_grid.modules.destinations.groups module
+------------------------------------------------------
+
+.. automodule:: marl_factory_grid.modules.destinations.groups
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+marl\_factory\_grid.modules.destinations.rules module
+-----------------------------------------------------
+
+.. automodule:: marl_factory_grid.modules.destinations.rules
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: marl_factory_grid.modules.destinations
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/code/marl_factory_grid.modules.doors.rst

@@ -0,0 +1,53 @@
+marl\_factory\_grid.modules.doors package
+=========================================
+
+Submodules
+----------
+
+marl\_factory\_grid.modules.doors.actions module
+------------------------------------------------
+
+.. automodule:: marl_factory_grid.modules.doors.actions
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+marl\_factory\_grid.modules.doors.constants module
+--------------------------------------------------
+
+.. automodule:: marl_factory_grid.modules.doors.constants
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+marl\_factory\_grid.modules.doors.entitites module
+--------------------------------------------------
+
+.. automodule:: marl_factory_grid.modules.doors.entitites
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+marl\_factory\_grid.modules.doors.groups module
+-----------------------------------------------
+
+.. automodule:: marl_factory_grid.modules.doors.groups
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+marl\_factory\_grid.modules.doors.rules module
+----------------------------------------------
+
+.. automodule:: marl_factory_grid.modules.doors.rules
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: marl_factory_grid.modules.doors
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/code/marl_factory_grid.modules.items.rst

@@ -0,0 +1,53 @@
+marl\_factory\_grid.modules.items package
+=========================================
+
+Submodules
+----------
+
+marl\_factory\_grid.modules.items.actions module
+------------------------------------------------
+
+.. automodule:: marl_factory_grid.modules.items.actions
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+marl\_factory\_grid.modules.items.constants module
+--------------------------------------------------
+
+.. automodule:: marl_factory_grid.modules.items.constants
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+marl\_factory\_grid.modules.items.entitites module
+--------------------------------------------------
+
+.. automodule:: marl_factory_grid.modules.items.entitites
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+marl\_factory\_grid.modules.items.groups module
+-----------------------------------------------
+
+.. automodule:: marl_factory_grid.modules.items.groups
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+marl\_factory\_grid.modules.items.rules module
+----------------------------------------------
+
+.. automodule:: marl_factory_grid.modules.items.rules
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: marl_factory_grid.modules.items
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/code/marl_factory_grid.modules.machines.rst

@@ -0,0 +1,53 @@
+marl\_factory\_grid.modules.machines package
+============================================
+
+Submodules
+----------
+
+marl\_factory\_grid.modules.machines.actions module
+---------------------------------------------------
+
+.. automodule:: marl_factory_grid.modules.machines.actions
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+marl\_factory\_grid.modules.machines.constants module
+-----------------------------------------------------
+
+.. automodule:: marl_factory_grid.modules.machines.constants
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+marl\_factory\_grid.modules.machines.entitites module
+-----------------------------------------------------
+
+.. automodule:: marl_factory_grid.modules.machines.entitites
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+marl\_factory\_grid.modules.machines.groups module
+--------------------------------------------------
+
+.. automodule:: marl_factory_grid.modules.machines.groups
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+marl\_factory\_grid.modules.machines.rules module
+-------------------------------------------------
+
+.. automodule:: marl_factory_grid.modules.machines.rules
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: marl_factory_grid.modules.machines
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/code/marl_factory_grid.modules.maintenance.rst

@@ -0,0 +1,45 @@
+marl\_factory\_grid.modules.maintenance package
+===============================================
+
+Submodules
+----------
+
+marl\_factory\_grid.modules.maintenance.constants module
+--------------------------------------------------------
+
+.. automodule:: marl_factory_grid.modules.maintenance.constants
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+marl\_factory\_grid.modules.maintenance.entities module
+-------------------------------------------------------
+
+.. automodule:: marl_factory_grid.modules.maintenance.entities
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+marl\_factory\_grid.modules.maintenance.groups module
+-----------------------------------------------------
+
+.. automodule:: marl_factory_grid.modules.maintenance.groups
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+marl\_factory\_grid.modules.maintenance.rules module
+----------------------------------------------------
+
+.. automodule:: marl_factory_grid.modules.maintenance.rules
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: marl_factory_grid.modules.maintenance
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/code/marl_factory_grid.modules.rst

@@ -0,0 +1,25 @@
+marl\_factory\_grid.modules package
+===================================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   marl_factory_grid.modules.batteries
+   marl_factory_grid.modules.clean_up
+   marl_factory_grid.modules.destinations
+   marl_factory_grid.modules.doors
+   marl_factory_grid.modules.items
+   marl_factory_grid.modules.machines
+   marl_factory_grid.modules.maintenance
+   marl_factory_grid.modules.zones
+
+Module contents
+---------------
+
+.. automodule:: marl_factory_grid.modules
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/code/marl_factory_grid.modules.zones.rst

@@ -0,0 +1,45 @@
+marl\_factory\_grid.modules.zones package
+=========================================
+
+Submodules
+----------
+
+marl\_factory\_grid.modules.zones.constants module
+--------------------------------------------------
+
+.. automodule:: marl_factory_grid.modules.zones.constants
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+marl\_factory\_grid.modules.zones.entitites module
+--------------------------------------------------
+
+.. automodule:: marl_factory_grid.modules.zones.entitites
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+marl\_factory\_grid.modules.zones.groups module
+-----------------------------------------------
+
+.. automodule:: marl_factory_grid.modules.zones.groups
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+marl\_factory\_grid.modules.zones.rules module
+----------------------------------------------
+
+.. automodule:: marl_factory_grid.modules.zones.rules
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: marl_factory_grid.modules.zones
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/code/marl_factory_grid.rst

@@ -0,0 +1,32 @@
+marl\_factory\_grid package
+===========================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   marl_factory_grid.environment
+   marl_factory_grid.levels
+   marl_factory_grid.modules
+   marl_factory_grid.utils
+
+Submodules
+----------
+
+marl\_factory\_grid.quickstart module
+-------------------------------------
+
+.. automodule:: marl_factory_grid.quickstart
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: marl_factory_grid
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/code/marl_factory_grid.utils.logging.rst

@@ -0,0 +1,29 @@
+marl\_factory\_grid.utils.logging package
+=========================================
+
+Submodules
+----------
+
+marl\_factory\_grid.utils.logging.envmonitor module
+---------------------------------------------------
+
+.. automodule:: marl_factory_grid.utils.logging.envmonitor
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+marl\_factory\_grid.utils.logging.recorder module
+-------------------------------------------------
+
+.. automodule:: marl_factory_grid.utils.logging.recorder
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: marl_factory_grid.utils.logging
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/code/marl_factory_grid.utils.plotting.rst

@@ -0,0 +1,37 @@
+marl\_factory\_grid.utils.plotting package
+==========================================
+
+Submodules
+----------
+
+marl\_factory\_grid.utils.plotting.plot\_compare\_runs module
+-------------------------------------------------------------
+
+.. automodule:: marl_factory_grid.utils.plotting.plot_compare_runs
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+marl\_factory\_grid.utils.plotting.plot\_single\_runs module
+------------------------------------------------------------
+
+.. automodule:: marl_factory_grid.utils.plotting.plot_single_runs
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+marl\_factory\_grid.utils.plotting.plotting\_utils module
+---------------------------------------------------------
+
+.. automodule:: marl_factory_grid.utils.plotting.plotting_utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: marl_factory_grid.utils.plotting
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/code/marl_factory_grid.utils.rst

@@ -0,0 +1,102 @@
+marl\_factory\_grid.utils package
+=================================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   marl_factory_grid.utils.logging
+   marl_factory_grid.utils.plotting
+
+Submodules
+----------
+
+marl\_factory\_grid.utils.config\_parser module
+-----------------------------------------------
+
+.. automodule:: marl_factory_grid.utils.config_parser
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+marl\_factory\_grid.utils.helpers module
+----------------------------------------
+
+.. automodule:: marl_factory_grid.utils.helpers
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+marl\_factory\_grid.utils.level\_parser module
+----------------------------------------------
+
+.. automodule:: marl_factory_grid.utils.level_parser
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+marl\_factory\_grid.utils.observation\_builder module
+-----------------------------------------------------
+
+.. automodule:: marl_factory_grid.utils.observation_builder
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+marl\_factory\_grid.utils.ray\_caster module
+--------------------------------------------
+
+.. automodule:: marl_factory_grid.utils.ray_caster
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+marl\_factory\_grid.utils.renderer module
+-----------------------------------------
+
+.. automodule:: marl_factory_grid.utils.renderer
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+marl\_factory\_grid.utils.results module
+----------------------------------------
+
+.. automodule:: marl_factory_grid.utils.results
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+marl\_factory\_grid.utils.states module
+---------------------------------------
+
+.. automodule:: marl_factory_grid.utils.states
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+marl\_factory\_grid.utils.tools module
+--------------------------------------
+
+.. automodule:: marl_factory_grid.utils.tools
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+marl\_factory\_grid.utils.utility\_classes module
+-------------------------------------------------
+
+.. automodule:: marl_factory_grid.utils.utility_classes
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: marl_factory_grid.utils
+   :members:
+   :undoc-members:
+   :show-inheritance: