forked from projectmesa/mesa
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Convert visualization .rst -> .md via rst2myst (projectmesa#2036)
- Loading branch information
Showing
4 changed files
with
171 additions
and
169 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
# mesa.visualization package | ||
|
||
## Subpackages | ||
|
||
```{toctree} | ||
mesa.visualization.modules | ||
``` | ||
|
||
## Submodules | ||
|
||
## mesa.visualization.ModularVisualization module | ||
|
||
```{eval-rst} | ||
.. automodule:: mesa.visualization.ModularVisualization | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
``` | ||
|
||
## mesa.visualization.TextVisualization module | ||
|
||
```{eval-rst} | ||
.. automodule:: mesa.visualization.TextVisualization | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
``` | ||
|
||
## mesa.visualization.UserParam module | ||
|
||
```{eval-rst} | ||
.. automodule:: mesa.visualization.UserParam | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
``` | ||
|
||
## Module contents | ||
|
||
```{eval-rst} | ||
.. automodule:: mesa.visualization | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
``` |
46 changes: 26 additions & 20 deletions
46
docs/mesa.visualization.modules.rst → docs/mesa.visualization.modules.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,70 +1,76 @@ | ||
mesa.visualization.modules package | ||
================================== | ||
# mesa.visualization.modules package | ||
|
||
Submodules | ||
---------- | ||
## Submodules | ||
|
||
mesa.visualization.modules.BarChartVisualization module | ||
------------------------------------------------------- | ||
## mesa.visualization.modules.BarChartVisualization module | ||
|
||
```{eval-rst} | ||
.. automodule:: mesa.visualization.modules.BarChartVisualization | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
``` | ||
|
||
mesa.visualization.modules.CanvasGridVisualization module | ||
--------------------------------------------------------- | ||
## mesa.visualization.modules.CanvasGridVisualization module | ||
|
||
```{eval-rst} | ||
.. automodule:: mesa.visualization.modules.CanvasGridVisualization | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
``` | ||
|
||
mesa.visualization.modules.ChartVisualization module | ||
---------------------------------------------------- | ||
## mesa.visualization.modules.ChartVisualization module | ||
|
||
```{eval-rst} | ||
.. automodule:: mesa.visualization.modules.ChartVisualization | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
``` | ||
|
||
mesa.visualization.modules.HexGridVisualization module | ||
------------------------------------------------------ | ||
## mesa.visualization.modules.HexGridVisualization module | ||
|
||
```{eval-rst} | ||
.. automodule:: mesa.visualization.modules.HexGridVisualization | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
``` | ||
|
||
mesa.visualization.modules.NetworkVisualization module | ||
------------------------------------------------------ | ||
## mesa.visualization.modules.NetworkVisualization module | ||
|
||
```{eval-rst} | ||
.. automodule:: mesa.visualization.modules.NetworkVisualization | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
``` | ||
|
||
mesa.visualization.modules.PieChartVisualization module | ||
------------------------------------------------------- | ||
## mesa.visualization.modules.PieChartVisualization module | ||
|
||
```{eval-rst} | ||
.. automodule:: mesa.visualization.modules.PieChartVisualization | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
``` | ||
|
||
mesa.visualization.modules.TextVisualization module | ||
--------------------------------------------------- | ||
## mesa.visualization.modules.TextVisualization module | ||
|
||
```{eval-rst} | ||
.. automodule:: mesa.visualization.modules.TextVisualization | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
``` | ||
|
||
Module contents | ||
--------------- | ||
## Module contents | ||
|
||
```{eval-rst} | ||
.. automodule:: mesa.visualization.modules | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
``` |
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.