Skip to content

Commit a83b8d3

Browse files
authored
docs: Convert api/*.rst -> api/*.md via rst2myst (#2035)
1 parent 2f7a39b commit a83b8d3

File tree

9 files changed

+45
-22
lines changed

9 files changed

+45
-22
lines changed

docs/apis/api_main.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# APIs
2+
3+
```{toctree}
4+
:maxdepth: 3
5+
6+
Base Classes <init>
7+
time
8+
space
9+
datacollection
10+
batchrunner
11+
visualization
12+
```

docs/apis/api_main.rst

Lines changed: 0 additions & 12 deletions
This file was deleted.
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,4 @@
1+
```{eval-rst}
12
.. automodule:: batchrunner
23
:members:
4+
```
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,4 @@
1+
```{eval-rst}
12
.. automodule:: datacollection
23
:members:
4+
```
Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
1-
Base Classes
2-
----
1+
# Base Classes
32

3+
```{eval-rst}
44
.. autoclass:: mesa.Agent
55
:members:
6+
```
67

8+
```{eval-rst}
79
.. autoclass:: mesa.Model
8-
:members:
10+
:members:
11+
```

docs/apis/space.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
```{eval-rst}
2+
.. automodule:: mesa.space
3+
:members:
4+
:inherited-members:
5+
```

docs/apis/space.rst

Lines changed: 0 additions & 3 deletions
This file was deleted.
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
```{eval-rst}
12
.. automodule:: mesa.time
23
:members:
34
:inherited-members:
5+
```
Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,38 @@
1-
Visualization
2-
-------------
1+
# Visualization
32

3+
```{eval-rst}
44
.. automodule:: visualization.__init__
55
:members:
6+
```
67

8+
```{eval-rst}
79
.. automodule:: visualization.ModularVisualization
810
:members:
11+
```
912

13+
```{eval-rst}
1014
.. automodule:: visualization.TextVisualization
1115
:members:
16+
```
1217

13-
Modules
14-
~~~~~~~
18+
## Modules
1519

20+
```{eval-rst}
1621
.. automodule:: visualization.modules.__init__
1722
:members:
23+
```
1824

25+
```{eval-rst}
1926
.. automodule:: visualization.modules.CanvasGridVisualization
2027
:members:
28+
```
2129

30+
```{eval-rst}
2231
.. automodule:: visualization.modules.ChartVisualization
2332
:members:
33+
```
2434

35+
```{eval-rst}
2536
.. automodule:: visualization.modules.TextVisualization
2637
:members:
38+
```

0 commit comments

Comments
 (0)