Skip to content

Commit

Permalink
Deploy documentation to GitHub Pages
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Oct 9, 2024
0 parents commit a1529b7
Show file tree
Hide file tree
Showing 41 changed files with 5,191 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: a8de04bb823c1d74e6cf8285fb2ee4c0
tags: 645f666f9bcd5a90fca523b33c5a78b7
Empty file added .nojekyll
Empty file.
Binary file added _images/trans_bg.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 8 additions & 0 deletions _sources/documentation/human_agents.md.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
:orphan:

# Human drivers

```{eval-rst}
.. autoclass:: RouteRL.environment.agent.HumanAgent
:members:
```
6 changes: 6 additions & 0 deletions _sources/documentation/machine_agents.md.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Automated Vehicle (AV) agents

```{eval-rst}
.. autoclass:: RouteRL.environment.agent.MachineAgent
:members:
```
15 changes: 15 additions & 0 deletions _sources/documentation/observations.md.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Observation functions

To create a new observation function, you must create a class that inherits from the Observations class:

```{eval-rst}
.. autoclass:: RouteRL.environment.observations.Observations
:members:
```

The default observation function is the PreviousAgentStart class:

```{eval-rst}
.. autoclass:: RouteRL.environment.observations.PreviousAgentStart
:members:
```
6 changes: 6 additions & 0 deletions _sources/documentation/pz_env.md.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# PettingZoo environment

```{eval-rst}
.. autoclass:: RouteRL.environment.environment.TrafficEnvironment
:members:
```
6 changes: 6 additions & 0 deletions _sources/documentation/simulator.md.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# SUMO simulator

```{eval-rst}
.. autoclass:: RouteRL.environment.simulator.SumoSimulator
:members:
```
23 changes: 23 additions & 0 deletions _sources/index.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
.. 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/simulator
documentation/pz_env
documentation/machine_agents
documentation/human_agents
documentation/observations
Loading

0 comments on commit a1529b7

Please sign in to comment.