Amend

facebookresearch · Nov 22, 2023 · eb3eaef · eb3eaef
1 parent e57ab45
commit eb3eaef
Show file tree

Hide file tree

Showing 3 changed files with 58 additions and 0 deletions.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -53,3 +53,10 @@ the domain and want to easily take a picture of the landscape.
    concepts/extending
    concepts/configuring
    concepts/features
+
+.. 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:
+
+Common
+------
+.. currentmodule:: benchmarl.algorithms
+
+.. autosummary::
+   :nosignatures:
+   :toctree: ../generated
+   :template: autosummary/class.rst
+
+   {% for name in benchmarl.algorithms.common %}
+     {{ name }}
+   {% endfor %}
+
+Algorithms
+----------
+
+.. currentmodule:: benchmarl.algorithms
+
+.. autosummary::
+   :nosignatures:
+   :toctree: ../generated
+   :template: autosummary/class.rst
+
+   {% for name in benchmarl.algorithms.classes %}
+     {{ name }}
+   {% endfor %}
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: