Skip to content

Commit

Permalink
docs: Convert visualization .rst -> .md via rst2myst (projectmesa#2036)
Browse files Browse the repository at this point in the history
  • Loading branch information
rht authored Feb 21, 2024
1 parent a83b8d3 commit d65f41c
Show file tree
Hide file tree
Showing 4 changed files with 171 additions and 169 deletions.
46 changes: 46 additions & 0 deletions docs/mesa.visualization.md
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:
```
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:
```
45 changes: 0 additions & 45 deletions docs/mesa.visualization.rst

This file was deleted.

Loading

0 comments on commit d65f41c

Please sign in to comment.