spinx going book

2025-06-18 18:52:52 +02:00 · 2023-12-12 17:51:37 +01:00
parent 7feba6d452
commit e7933985cb
44 changed files with 392 additions and 310 deletions
--- a/docs/source/code.rst
+++ b/docs/source/code.rst
@ -1,8 +0,0 @@
-Code
-====
-
-.. toctree::
-   :maxdepth: 1
-   :glob:
-
-   code/*
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@ -15,30 +15,47 @@ release = '2.5.0'
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

 extensions = [#'myst_parser',
-              'sphinx.ext.autodoc',
-              'sphinx.ext.autosummary',
-              'sphinx.ext.linkcode',
-              'sphinx_mdinclude',
+                  'sphinx.ext.todo',
+                  'sphinx.ext.autodoc',
+                  'sphinx.ext.intersphinx',
+                  # 'sphinx.ext.autosummary',
+                  'sphinx.ext.linkcode',
+                  'sphinx_mdinclude',
              ]

 templates_path = ['_templates']
 exclude_patterns = ['marl_factory_grid.utils.proto', 'marl_factory_grid.utils.proto.fiksProto_pb2*']

+
+autoclass_content = 'both'
+autodoc_class_signature = 'separated'
+autodoc_typehints = 'description'
+autodoc_inherit_docstrings = True
+autodoc_typehints_format = 'short'
+autodoc_default_options = {
+    'members': True,
+    # 'member-order': 'bysource',
+    'special-members': '__init__',
+    'undoc-members': True,
+    # 'exclude-members': '__weakref__',
+    'show-inheritance': True,
+}
+autosummary_generate = True
+add_module_names = False
+toc_object_entries = False
+modindex_common_prefix = ['marl_factory_grid.']
+
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here.
 from pathlib import Path
 import sys
 sys.path.insert(0, (Path(__file__).parents[2]).resolve().as_posix())
 sys.path.insert(0, (Path(__file__).parents[2] / 'marl_factory_grid').resolve().as_posix())
-import sphinx_pdj_theme

 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
-html_theme = 'alabaster'
-html_theme_path = [sphinx_pdj_theme.get_html_theme_path()]
-
-
-html_static_path = ['_static']
+html_theme = "sphinx_book_theme"  # 'alabaster'
+# html_static_path = ['_static']

 # In your configuration, you need to specify a linkcode_resolve function that returns an URL based on the object.
 # https://www.sphinx-doc.org/en/master/usage/extensions/linkcode.html
@ -52,9 +69,4 @@ def linkcode_resolve(domain, info):
    filename = info['module'].replace('.', '/')
    return "https://github.com/illiumst/marl-factory-grid/%s.py" % filename

-
-autoclass_content = 'both'
-autosummary_generate = True
-add_module_names = False
-
-print(sys.executable)
+print(sys.executable)
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@ -1,30 +1,20 @@
-.. marl-factory-grid documentation master file, created by
-   sphinx-quickstart on Fri Dec  1 12:55:36 2023.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
-Welcome to marl-factory-grid's documentation!
-=============================================
-
-.. mdinclude:: ../../README.md
-
-Test
-
 .. toctree::
   :maxdepth: 1
-   :caption: Contents:
+   :caption: Table of Contents
+   :titlesonly:

   installation
   usage
   modifications
-   code
-
+   source

 .. note::
   This project is under active development.

+.. mdinclude:: ../../README.md
+
 Indices and tables
-==================
+------------------

 * :ref:`genindex`
 * :ref:`modindex`
--- a/docs/source/installation.rst
+++ b/docs/source/installation.rst
@ -13,4 +13,10 @@ To use `marl-factory-grid`, first install it using pip:
   (.venv) $ pip install marl-factory-grid


+Indices and tables
+------------------
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

--- a/docs/source/modifications.rst
+++ b/docs/source/modifications.rst
@ -1,5 +1,7 @@
-How to modify the environment or write modules
-==============================================
+Custom Modifications
+====================
+
+This section covers main aspects of working with the environment.

 Modifying levels
 ----------------
@ -68,3 +70,10 @@ PNG-files (transparent background) of square aspect-ratio should do the job, in
   :alt: Wall Image
 .. image:: ../../marl_factory_grid/environment/assets/agent/agent.png
   :alt: Agent Image
+
+Indices and tables
+------------------
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
--- a/docs/source/source.rst
+++ b/docs/source/source.rst
@ -0,0 +1,17 @@
+Source
+======
+
+.. toctree::
+   :maxdepth: 2
+   :glob:
+   :caption: Table of Contents
+   :titlesonly:
+
+   source/*
+
+Indices and tables
+------------------
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
--- a/docs/source/source/marl_factory_grid.environment.entity.rst
+++ b/docs/source/source/marl_factory_grid.environment.entity.rst
@ -1,53 +1,40 @@
 marl\_factory\_grid.environment.entity package
 ==============================================

+.. automodule:: marl_factory_grid.environment.entity
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 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:
--- a/docs/source/source/marl_factory_grid.environment.groups.rst
+++ b/docs/source/source/marl_factory_grid.environment.groups.rst
@ -1,69 +1,52 @@
 marl\_factory\_grid.environment.groups package
 ==============================================

+.. automodule:: marl_factory_grid.environment.groups
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 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:
--- a/docs/source/source/marl_factory_grid.environment.rst
+++ b/docs/source/source/marl_factory_grid.environment.rst
@ -1,6 +1,11 @@
 marl\_factory\_grid.environment package
 =======================================

+.. automodule:: marl_factory_grid.environment
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 Subpackages
 -----------

@ -13,50 +18,32 @@ Subpackages
 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:
--- a/docs/source/source/marl_factory_grid.levels.rst
+++ b/docs/source/source/marl_factory_grid.levels.rst
@ -1,9 +1,6 @@
 marl\_factory\_grid.levels package
 ==================================

-Module contents
---------------
-
 .. automodule:: marl_factory_grid.levels
   :members:
   :undoc-members:
--- a/docs/source/source/marl_factory_grid.modules.batteries.rst
+++ b/docs/source/source/marl_factory_grid.modules.batteries.rst
@ -1,45 +1,40 @@
 marl\_factory\_grid.modules.batteries package
 =============================================

+.. automodule:: marl_factory_grid.modules.batteries
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 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.entitites module
------------------------------------------------------
+
+.. automodule:: marl_factory_grid.modules.batteries.constants
+   :members:
+   :undoc-members:
+   :show-inheritance:
+

 .. 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:
--- a/docs/source/source/marl_factory_grid.modules.clean_up.rst
+++ b/docs/source/source/marl_factory_grid.modules.clean_up.rst
@ -1,45 +1,40 @@
 marl\_factory\_grid.modules.clean\_up package
 =============================================

+.. automodule:: marl_factory_grid.modules.clean_up
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 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.entitites module
------------------------------------------------------
+
+.. automodule:: marl_factory_grid.modules.clean_up.constants
+   :members:
+   :undoc-members:
+   :show-inheritance:
+

 .. 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:
--- a/docs/source/source/marl_factory_grid.modules.destinations.rst
+++ b/docs/source/source/marl_factory_grid.modules.destinations.rst
@ -1,45 +1,40 @@
 marl\_factory\_grid.modules.destinations package
 ================================================

+.. automodule:: marl_factory_grid.modules.destinations
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 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.entitites module
---------------------------------------------------------
+
+.. automodule:: marl_factory_grid.modules.destinations.constants
+   :members:
+   :undoc-members:
+   :show-inheritance:
+

 .. 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:
--- a/docs/source/source/marl_factory_grid.modules.doors.rst
+++ b/docs/source/source/marl_factory_grid.modules.doors.rst
@ -1,45 +1,40 @@
 marl\_factory\_grid.modules.doors package
 =========================================

+.. automodule:: marl_factory_grid.modules.doors
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 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.entitites module
--------------------------------------------------
+
+.. automodule:: marl_factory_grid.modules.doors.constants
+   :members:
+   :undoc-members:
+   :show-inheritance:
+

 .. 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:
--- a/docs/source/source/marl_factory_grid.modules.items.rst
+++ b/docs/source/source/marl_factory_grid.modules.items.rst
@ -1,45 +1,40 @@
 marl\_factory\_grid.modules.items package
 =========================================

+.. automodule:: marl_factory_grid.modules.items
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 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.entitites module
--------------------------------------------------
+
+.. automodule:: marl_factory_grid.modules.items.constants
+   :members:
+   :undoc-members:
+   :show-inheritance:
+

 .. 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:
--- a/docs/source/source/marl_factory_grid.modules.machines.rst
+++ b/docs/source/source/marl_factory_grid.modules.machines.rst
@ -1,45 +1,40 @@
 marl\_factory\_grid.modules.machines package
 ============================================

+.. automodule:: marl_factory_grid.modules.machines
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 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.entitites module
-----------------------------------------------------
+
+.. automodule:: marl_factory_grid.modules.machines.constants
+   :members:
+   :undoc-members:
+   :show-inheritance:
+

 .. 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:
--- a/docs/source/source/marl_factory_grid.modules.maintenance.rst
+++ b/docs/source/source/marl_factory_grid.modules.maintenance.rst
@ -1,37 +1,34 @@
 marl\_factory\_grid.modules.maintenance package
 ===============================================

+.. automodule:: marl_factory_grid.modules.maintenance
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 Submodules
 ----------

-marl\_factory\_grid.modules.maintenance.entities module
-------------------------------------------------------
+
+.. automodule:: marl_factory_grid.modules.maintenance.constants
+   :members:
+   :undoc-members:
+   :show-inheritance:
+

 .. 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:
--- a/docs/source/source/marl_factory_grid.modules.rst
+++ b/docs/source/source/marl_factory_grid.modules.rst
@ -1,6 +1,11 @@
 marl\_factory\_grid.modules package
 ===================================

+.. automodule:: marl_factory_grid.modules
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 Subpackages
 -----------

@ -15,11 +20,3 @@ Subpackages
   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:
--- a/docs/source/source/marl_factory_grid.modules.zones.rst
+++ b/docs/source/source/marl_factory_grid.modules.zones.rst
@ -1,37 +1,34 @@
 marl\_factory\_grid.modules.zones package
 =========================================

+.. automodule:: marl_factory_grid.modules.zones
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 Submodules
 ----------

-marl\_factory\_grid.modules.zones.entitites module
--------------------------------------------------
+
+.. automodule:: marl_factory_grid.modules.zones.constants
+   :members:
+   :undoc-members:
+   :show-inheritance:
+

 .. 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:
--- a/docs/source/source/marl_factory_grid.rst
+++ b/docs/source/source/marl_factory_grid.rst
@ -1,12 +1,18 @@
 marl\_factory\_grid package
 ===========================

+.. automodule:: marl_factory_grid
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 Subpackages
 -----------

 .. toctree::
   :maxdepth: 4

+   marl_factory_grid.algorithms
   marl_factory_grid.environment
   marl_factory_grid.levels
   marl_factory_grid.modules
@ -15,18 +21,8 @@ Subpackages
 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:
--- a/docs/source/source/marl_factory_grid.utils.logging.rst
+++ b/docs/source/source/marl_factory_grid.utils.logging.rst
@ -1,29 +1,22 @@
 marl\_factory\_grid.utils.logging package
 =========================================

+.. automodule:: marl_factory_grid.utils.logging
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 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:
--- a/docs/source/source/marl_factory_grid.utils.plotting.rst
+++ b/docs/source/source/marl_factory_grid.utils.plotting.rst
@ -1,37 +1,28 @@
 marl\_factory\_grid.utils.plotting package
 ==========================================

+.. automodule:: marl_factory_grid.utils.plotting
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 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:
--- a/docs/source/source/marl_factory_grid.utils.rst
+++ b/docs/source/source/marl_factory_grid.utils.rst
@ -1,6 +1,11 @@
 marl\_factory\_grid.utils package
 =================================

+.. automodule:: marl_factory_grid.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 Subpackages
 -----------

@ -13,90 +18,62 @@ Subpackages
 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:
--- a/docs/source/usage.rst
+++ b/docs/source/usage.rst
@ -1,5 +1,5 @@
-Using the environment with your agents
-======================================
+Basic Usage
+===========

 Environment objects, including agents, entities and rules, that are specified in a *yaml*-configfile will be loaded automatically.
 Using ``quickstart_use`` creates a default config-file and another one that lists all possible options of the environment.
@ -63,3 +63,11 @@ Evaluating the run
 If monitoring and recording are enabled, the environment states will be traced and recorded automatically.

 Plotting. At the moment a plot of the evaluation score across the different episodes is automatically generated.
+
+
+Indices and tables
+------------------
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`