Sphinx AutoDocs init

docs/source/code.rst

@@ -0,0 +1,8 @@
+Code
+====
+
+.. autosummary::
+   :recursive:
+   :toctree: generated
+
+    marl_factory_grid

docs/source/conf.py

@@ -0,0 +1,38 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'marl-factory-grid'
+copyright = '2023, Steffen Illium, Robert Mueller, Joel Friedrich'
+author = 'Steffen Illium, Robert Mueller, Joel Friedrich'
+release = '2.5.0'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = ['myst_parser',
+              'sphinx.ext.duration',
+              'sphinx.ext.doctest',
+              'sphinx.ext.autodoc',
+              'sphinx.ext.autosummary',
+
+              ]
+
+templates_path = ['_templates']
+exclude_patterns = ['marl_factory_grid.utils.proto']
+
+# 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())
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'alabaster'
+html_static_path = ['_static']

docs/source/index.rst

@@ -0,0 +1,29 @@
+.. 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!
+=============================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   installation
+   usage
+   modifications
+   code
+
+.. autosummary::
+   :toctree: generated
+
+.. note::
+   This project is under active development.
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/source/installation.rst

@@ -0,0 +1,16 @@
+Installation
+============
+
+
+
+How to install the environment
+------------------------------
+
+To use `marl-factory-grid`, first install it using pip:
+
+.. code-block:: console
+
+   (.venv) $ pip install marl-factory-grid
+
+
+

docs/source/modifications.rst

@@ -0,0 +1,5 @@
+How to modify the environment or write modules
+===============================================
+
+
+

docs/source/usage.rst

@@ -0,0 +1,3 @@
+How to use the environment with your agents
+===========================================
+