Skip to content

Commit d65f41c

Browse files
authored
docs: Convert visualization .rst -> .md via rst2myst (#2036)
1 parent a83b8d3 commit d65f41c

File tree

4 files changed

+171
-169
lines changed

4 files changed

+171
-169
lines changed

docs/mesa.visualization.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# mesa.visualization package
2+
3+
## Subpackages
4+
5+
```{toctree}
6+
mesa.visualization.modules
7+
```
8+
9+
## Submodules
10+
11+
## mesa.visualization.ModularVisualization module
12+
13+
```{eval-rst}
14+
.. automodule:: mesa.visualization.ModularVisualization
15+
:members:
16+
:undoc-members:
17+
:show-inheritance:
18+
```
19+
20+
## mesa.visualization.TextVisualization module
21+
22+
```{eval-rst}
23+
.. automodule:: mesa.visualization.TextVisualization
24+
:members:
25+
:undoc-members:
26+
:show-inheritance:
27+
```
28+
29+
## mesa.visualization.UserParam module
30+
31+
```{eval-rst}
32+
.. automodule:: mesa.visualization.UserParam
33+
:members:
34+
:undoc-members:
35+
:show-inheritance:
36+
37+
```
38+
39+
## Module contents
40+
41+
```{eval-rst}
42+
.. automodule:: mesa.visualization
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:
46+
```
Lines changed: 26 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,70 +1,76 @@
1-
mesa.visualization.modules package
2-
==================================
1+
# mesa.visualization.modules package
32

4-
Submodules
5-
----------
3+
## Submodules
64

7-
mesa.visualization.modules.BarChartVisualization module
8-
-------------------------------------------------------
5+
## mesa.visualization.modules.BarChartVisualization module
96

7+
```{eval-rst}
108
.. automodule:: mesa.visualization.modules.BarChartVisualization
119
:members:
1210
:undoc-members:
1311
:show-inheritance:
12+
```
1413

15-
mesa.visualization.modules.CanvasGridVisualization module
16-
---------------------------------------------------------
14+
## mesa.visualization.modules.CanvasGridVisualization module
1715

16+
```{eval-rst}
1817
.. automodule:: mesa.visualization.modules.CanvasGridVisualization
1918
:members:
2019
:undoc-members:
2120
:show-inheritance:
21+
```
2222

23-
mesa.visualization.modules.ChartVisualization module
24-
----------------------------------------------------
23+
## mesa.visualization.modules.ChartVisualization module
2524

25+
```{eval-rst}
2626
.. automodule:: mesa.visualization.modules.ChartVisualization
2727
:members:
2828
:undoc-members:
2929
:show-inheritance:
30+
```
3031

31-
mesa.visualization.modules.HexGridVisualization module
32-
------------------------------------------------------
32+
## mesa.visualization.modules.HexGridVisualization module
3333

34+
```{eval-rst}
3435
.. automodule:: mesa.visualization.modules.HexGridVisualization
3536
:members:
3637
:undoc-members:
3738
:show-inheritance:
39+
```
3840

39-
mesa.visualization.modules.NetworkVisualization module
40-
------------------------------------------------------
41+
## mesa.visualization.modules.NetworkVisualization module
4142

43+
```{eval-rst}
4244
.. automodule:: mesa.visualization.modules.NetworkVisualization
4345
:members:
4446
:undoc-members:
4547
:show-inheritance:
48+
```
4649

47-
mesa.visualization.modules.PieChartVisualization module
48-
-------------------------------------------------------
50+
## mesa.visualization.modules.PieChartVisualization module
4951

52+
```{eval-rst}
5053
.. automodule:: mesa.visualization.modules.PieChartVisualization
5154
:members:
5255
:undoc-members:
5356
:show-inheritance:
57+
```
5458

55-
mesa.visualization.modules.TextVisualization module
56-
---------------------------------------------------
59+
## mesa.visualization.modules.TextVisualization module
5760

61+
```{eval-rst}
5862
.. automodule:: mesa.visualization.modules.TextVisualization
5963
:members:
6064
:undoc-members:
6165
:show-inheritance:
6266
67+
```
6368

64-
Module contents
65-
---------------
69+
## Module contents
6670

71+
```{eval-rst}
6772
.. automodule:: mesa.visualization.modules
6873
:members:
6974
:undoc-members:
7075
:show-inheritance:
76+
```

docs/mesa.visualization.rst

Lines changed: 0 additions & 45 deletions
This file was deleted.

0 commit comments

Comments
 (0)