docs

COeXISTENCE-PROJECT · Nov 6, 2024 · d8429fd · d8429fd
1 parent c769300
commit d8429fd
Show file tree

Hide file tree

Showing 4 changed files with 40 additions and 40 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,34 @@
+---
+hide-toc: true
+firstpage:
+lastpage:
+---
+
+# RouteRL
+
+```{figure} _static/trans_bg.jpeg
+   :alt: RouteRL
+```
+
+```{include} ../README.md
+:start-after: <!-- start intro -->
+:end-before: <!-- end intro -->
+```
+
+```{toctree}
+:hidden:
+:caption: Documentation
+
+documentation/pz_env
+simulator
+documentation/machine_agents
+documentation/human_agents
+documentation/observations
+```
+
+```{toctree}
+:hidden:
+:caption: Development
+
+Github <https://github.com/COeXISTENCE-PROJECT/Milestone-One>
+```
diff --git a/docs/index.rst b/docs/index.rst
diff --git a/docs/simulator.md b/docs/simulator.md
@@ -0,0 +1,6 @@
+# SUMO simulator
+
+```{eval-rst}
+.. autoclass:: RouteRL.environment.simulator.SumoSimulator
+    :members:
+```
diff --git a/docs/simulator.rst b/docs/simulator.rst