Api docs (#2298)

projectmesa · Sep 18, 2024 · b95dd19 · b95dd19
1 parent 3fce592
commit b95dd19
Show file tree

Hide file tree

Showing 12 changed files with 40 additions and 27 deletions.
diff --git a/docs/apis/agent.md b/docs/apis/agent.md
@@ -0,0 +1,8 @@
+# Agent
+
+
+```{eval-rst}
+.. automodule:: mesa.agent
+   :members:
+   :inherited-members:
+```
diff --git a/docs/apis/api_main.md b/docs/apis/api_main.md
@@ -3,7 +3,8 @@
 ```{toctree}
 :maxdepth: 3
 
-Base Classes <init>
+model
+agent
 time
 space
 datacollection

diff --git a/docs/apis/batchrunner.md b/docs/apis/batchrunner.md
@@ -1,3 +1,5 @@
+# Batchrunner
+
 ```{eval-rst}
 .. automodule:: batchrunner
    :members:

diff --git a/docs/apis/datacollection.md b/docs/apis/datacollection.md
@@ -1,3 +1,5 @@
+# Data collection
+
 ```{eval-rst}
 .. automodule:: datacollection
    :members:

diff --git a/docs/apis/experimental.md b/docs/apis/experimental.md
@@ -1,9 +1,5 @@
 # Experimental
-
-```{eval-rst}
-.. automodule:: experimental.__init__
-   :members:
-```
+This namespace contains experimental features. These are under development, and their API is not necessarily stable.
 
 ## Cell Space
 

diff --git a/docs/apis/init.md b/docs/apis/init.md
diff --git a/docs/apis/model.md b/docs/apis/model.md
@@ -0,0 +1,7 @@
+# Model
+
+```{eval-rst}
+.. automodule:: mesa.model
+   :members:
+   :inherited-members:
+```
diff --git a/docs/apis/space.md b/docs/apis/space.md
@@ -1,3 +1,5 @@
+# Spaces
+
 ```{eval-rst}
 .. automodule:: mesa.space
    :members:

diff --git a/docs/apis/time.md b/docs/apis/time.md
@@ -1,3 +1,5 @@
+# Time
+
 ```{eval-rst}
 .. automodule:: mesa.time
    :members:

diff --git a/mesa/agent.py b/mesa/agent.py
@@ -1,6 +1,6 @@
-"""The agent class for Mesa framework.
+"""Agent related classes
 
-Core Objects: Agent
+Core Objects: Agent and AgentSet.
 """
 
 # Mypy; for the `|` operator purpose

diff --git a/mesa/experimental/cell_space/__init__.py b/mesa/experimental/cell_space/__init__.py
@@ -1,4 +1,9 @@
-"""Cell spaces."""
+"""Cell spaces.
+
+Cell spaces offer an alternative API for discrete spaces. It is experimental and under development. The API is more
+expressive that the default grids available in `mesa.space`.
+
+"""
 
 from mesa.experimental.cell_space.cell import Cell
 from mesa.experimental.cell_space.cell_agent import CellAgent

diff --git a/mesa/space.py b/mesa/space.py
@@ -2,13 +2,12 @@
 
 Objects used to add a spatial component to a model.
 
-Grid: base grid, which creates a rectangular grid.
-SingleGrid: extension to Grid which strictly enforces one agent per cell.
-MultiGrid: extension to Grid where each cell can contain a set of agents.
-HexGrid: extension to Grid to handle hexagonal neighbors.
-ContinuousSpace: a two-dimensional space where each agent has an arbitrary
-                 position of `float`'s.
-NetworkGrid: a network where each node contains zero or more agents.
+* Grid: base grid, which creates a rectangular grid.
+* SingleGrid: extension to Grid which strictly enforces one agent per cell.
+* MultiGrid: extension to Grid where each cell can contain a set of agents.
+* HexGrid: extension to Grid to handle hexagonal neighbors.
+* ContinuousSpace: a two-dimensional space where each agent has an arbitrary position of `float`'s.
+* NetworkGrid: a network where each node contains zero or more agents.
 """
 
 # Mypy; for the `|` operator purpose