amend

facebookresearch · Nov 2, 2023 · a39b100 · a39b100
1 parent 685dc7d
commit a39b100
Show file tree

Hide file tree

Showing 6 changed files with 67 additions and 21 deletions.
diff --git a/benchmarl/__init__.py b/benchmarl/__init__.py
@@ -4,16 +4,10 @@
 #  LICENSE file in the root directory of this source tree.
 #
 
-import importlib
 
-import benchmarl.algorithms
-import benchmarl.benchmark
-import benchmarl.environments
-import benchmarl.eval_results
-import benchmarl.experiment
-import benchmarl.models
-import benchmarl.utils
+__version__ = "0.0.4"
 
+import importlib
 
 _has_hydra = importlib.util.find_spec("hydra") is not None
 

diff --git a/docs/source/api.rst b/docs/source/api.rst
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -1,13 +1,12 @@
 # Configuration file for the Sphinx documentation builder.
 
 # -- Project information
+import benchmarl
 
 project = "BenchMARL"
 copyright = "Meta"
 author = "Matteo Bettini"
-
-release = "0.0.2"
-version = "0.0.2"
+version = benchmarl.__version__
 
 # -- General configuration
 
@@ -17,6 +16,7 @@
     "sphinx.ext.autodoc",
     "sphinx.ext.autosummary",
     "sphinx.ext.intersphinx",
+    "sphinx.ext.viewcode",
 ]
 
 intersphinx_mapping = {

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,5 +1,5 @@
-Welcome to Lumache's documentation!
-===================================
+BenchMARL
+=========
 
 **BenchMARL**  is a Python library for cooks and food lovers
 that creates recipes mixing random ingredients.
@@ -17,6 +17,14 @@ Contents
 --------
 
 .. toctree::
+   :maxdepth: 1
+   :caption: Usage
 
    usage
-   api
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Package Reference
+
+   modules/root
+   modules/algorithms
diff --git a/docs/source/modules/algorithms.rst b/docs/source/modules/algorithms.rst
@@ -0,0 +1,33 @@
+
+benchmarl.algorithms
+====================
+
+
+.. contents:: Contents
+    :local:
+
+Single node data collectors
+---------------------------
+
+.. currentmodule:: benchmarl.algorithms
+.. autosummary::
+   :toctree: generated
+
+   Iddpg
+   IddpgConfig
+   Ippo
+   IppoConfig
+   Iql
+   IqlConfig
+   Isac
+   IsacConfig
+   Maddpg
+   MaddpgConfig
+   Mappo
+   MappoConfig
+   Masac
+   MasacConfig
+   Qmix
+   QmixConfig
+   Vdn
+   VdnConfig
diff --git a/docs/source/modules/root.rst b/docs/source/modules/root.rst
@@ -0,0 +1,18 @@
+benchmarl
+=========
+
+
+.. automodule:: benchmarl.benchmark
+    :members:
+
+.. automodule:: benchmarl.eval_results
+    :members:
+
+.. automodule:: benchmarl.hydra_config
+    :members:
+
+.. automodule:: benchmarl.run
+    :members:
+
+.. automodule:: benchmarl.utils
+    :members: