doc

COeXISTENCE-PROJECT · Oct 9, 2024 · 74da847 · 74da847
1 parent d4e1982
commit 74da847
Show file tree

Hide file tree

Showing 23 changed files with 125 additions and 53 deletions.
diff --git a/docs/_build/doctrees/documentation/human_agents.doctree b/docs/_build/doctrees/documentation/human_agents.doctree
diff --git a/docs/_build/doctrees/documentation/machine_agents.doctree b/docs/_build/doctrees/documentation/machine_agents.doctree
diff --git a/docs/_build/doctrees/documentation/observations.doctree b/docs/_build/doctrees/documentation/observations.doctree
diff --git a/docs/_build/doctrees/documentation/pz_env.doctree b/docs/_build/doctrees/documentation/pz_env.doctree
diff --git a/docs/_build/doctrees/documentation/simulator.doctree b/docs/_build/doctrees/documentation/simulator.doctree
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree
diff --git a/docs/_build/html/_modules/RouteRL/environment/agent.html b/docs/_build/html/_modules/RouteRL/environment/agent.html
@@ -199,12 +199,16 @@
 <div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
   <p class="caption" role="heading"><span class="caption-text">Documentation</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="../../../documentation/simulator.html">SUMO simulator</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../documentation/pz_env.html">PettingZoo environment</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../documentation/simulator.html">SUMO simulator</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../documentation/machine_agents.html">Automated Vehicle (AV) agents</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../documentation/human_agents.html">Human drivers</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../documentation/observations.html">Observation functions</a></li>
 </ul>
+<p class="caption" role="heading"><span class="caption-text">Development</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference external" href="https://github.com/COeXISTENCE-PROJECT/Milestone-One">Github</a></li>
+</ul>
 
 </div>
 </div>

diff --git a/docs/_build/html/_modules/RouteRL/environment/environment.html b/docs/_build/html/_modules/RouteRL/environment/environment.html
@@ -199,12 +199,16 @@
 <div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
   <p class="caption" role="heading"><span class="caption-text">Documentation</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="../../../documentation/simulator.html">SUMO simulator</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../documentation/pz_env.html">PettingZoo environment</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../documentation/simulator.html">SUMO simulator</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../documentation/machine_agents.html">Automated Vehicle (AV) agents</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../documentation/human_agents.html">Human drivers</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../documentation/observations.html">Observation functions</a></li>
 </ul>
+<p class="caption" role="heading"><span class="caption-text">Development</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference external" href="https://github.com/COeXISTENCE-PROJECT/Milestone-One">Github</a></li>
+</ul>
 
 </div>
 </div>

diff --git a/docs/_build/html/_modules/RouteRL/environment/observations.html b/docs/_build/html/_modules/RouteRL/environment/observations.html
@@ -199,12 +199,16 @@
 <div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
   <p class="caption" role="heading"><span class="caption-text">Documentation</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="../../../documentation/simulator.html">SUMO simulator</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../documentation/pz_env.html">PettingZoo environment</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../documentation/simulator.html">SUMO simulator</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../documentation/machine_agents.html">Automated Vehicle (AV) agents</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../documentation/human_agents.html">Human drivers</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../documentation/observations.html">Observation functions</a></li>
 </ul>
+<p class="caption" role="heading"><span class="caption-text">Development</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference external" href="https://github.com/COeXISTENCE-PROJECT/Milestone-One">Github</a></li>
+</ul>
 
 </div>
 </div>

diff --git a/docs/_build/html/_modules/RouteRL/environment/simulator.html b/docs/_build/html/_modules/RouteRL/environment/simulator.html
@@ -199,12 +199,16 @@
 <div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
   <p class="caption" role="heading"><span class="caption-text">Documentation</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="../../../documentation/simulator.html">SUMO simulator</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../documentation/pz_env.html">PettingZoo environment</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../documentation/simulator.html">SUMO simulator</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../documentation/machine_agents.html">Automated Vehicle (AV) agents</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../documentation/human_agents.html">Human drivers</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../documentation/observations.html">Observation functions</a></li>
 </ul>
+<p class="caption" role="heading"><span class="caption-text">Development</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference external" href="https://github.com/COeXISTENCE-PROJECT/Milestone-One">Github</a></li>
+</ul>
 
 </div>
 </div>

diff --git a/docs/_build/html/_modules/index.html b/docs/_build/html/_modules/index.html
@@ -199,12 +199,16 @@
 <div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
   <p class="caption" role="heading"><span class="caption-text">Documentation</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="../documentation/simulator.html">SUMO simulator</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../documentation/pz_env.html">PettingZoo environment</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../documentation/simulator.html">SUMO simulator</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../documentation/machine_agents.html">Automated Vehicle (AV) agents</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../documentation/human_agents.html">Human drivers</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../documentation/observations.html">Observation functions</a></li>
 </ul>
+<p class="caption" role="heading"><span class="caption-text">Development</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference external" href="https://github.com/COeXISTENCE-PROJECT/Milestone-One">Github</a></li>
+</ul>
 
 </div>
 </div>

diff --git a/docs/_build/html/_sources/index.md.txt b/docs/_build/html/_sources/index.md.txt
@@ -19,9 +19,16 @@ lastpage:
 :hidden:
 :caption: Documentation
 
-documentation/simulator.md
 documentation/pz_env.md
+documentation/simulator.md
 documentation/machine_agents.md
 documentation/human_agents.md
 documentation/observations.md
+```
+
+```{toctree}
+:hidden:
+:caption: Development
+
+Github <https://github.com/COeXISTENCE-PROJECT/Milestone-One>
 ```
diff --git a/docs/_build/html/documentation/human_agents.html b/docs/_build/html/documentation/human_agents.html
@@ -200,12 +200,16 @@
 <div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
   <p class="caption" role="heading"><span class="caption-text">Documentation</span></p>
 <ul class="current">
-<li class="toctree-l1"><a class="reference internal" href="simulator.html">SUMO simulator</a></li>
 <li class="toctree-l1"><a class="reference internal" href="pz_env.html">PettingZoo environment</a></li>
+<li class="toctree-l1"><a class="reference internal" href="simulator.html">SUMO simulator</a></li>
 <li class="toctree-l1"><a class="reference internal" href="machine_agents.html">Automated Vehicle (AV) agents</a></li>
 <li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Human drivers</a></li>
 <li class="toctree-l1"><a class="reference internal" href="observations.html">Observation functions</a></li>
 </ul>
+<p class="caption" role="heading"><span class="caption-text">Development</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference external" href="https://github.com/COeXISTENCE-PROJECT/Milestone-One">Github</a></li>
+</ul>
 
 </div>
 </div>

diff --git a/docs/_build/html/documentation/machine_agents.html b/docs/_build/html/documentation/machine_agents.html
@@ -3,7 +3,7 @@
   <head><meta charset="utf-8"/>
     <meta name="viewport" content="width=device-width,initial-scale=1"/>
     <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
-<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Human drivers" href="human_agents.html" /><link rel="prev" title="PettingZoo environment" href="pz_env.html" />
+<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Human drivers" href="human_agents.html" /><link rel="prev" title="SUMO simulator" href="simulator.html" />
 
     <!-- Generated with Sphinx 8.0.2 and Furo 2024.08.06 -->
         <title>Automated Vehicle (AV) agents - RouteRL 0.0.1 documentation</title>
@@ -200,12 +200,16 @@
 <div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
   <p class="caption" role="heading"><span class="caption-text">Documentation</span></p>
 <ul class="current">
-<li class="toctree-l1"><a class="reference internal" href="simulator.html">SUMO simulator</a></li>
 <li class="toctree-l1"><a class="reference internal" href="pz_env.html">PettingZoo environment</a></li>
+<li class="toctree-l1"><a class="reference internal" href="simulator.html">SUMO simulator</a></li>
 <li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Automated Vehicle (AV) agents</a></li>
 <li class="toctree-l1"><a class="reference internal" href="human_agents.html">Human drivers</a></li>
 <li class="toctree-l1"><a class="reference internal" href="observations.html">Observation functions</a></li>
 </ul>
+<p class="caption" role="heading"><span class="caption-text">Development</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference external" href="https://github.com/COeXISTENCE-PROJECT/Milestone-One">Github</a></li>
+</ul>
 
 </div>
 </div>
@@ -293,14 +297,14 @@ <h1>Automated Vehicle (AV) agents<a class="headerlink" href="#automated-vehicle-
               </div>
               <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
             </a>
-          <a class="prev-page" href="pz_env.html">
+          <a class="prev-page" href="simulator.html">
               <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
               <div class="page-info">
                 <div class="context">
                   <span>Previous</span>
                 </div>
 
-                <div class="title">PettingZoo environment</div>
+                <div class="title">SUMO simulator</div>
 
               </div>
             </a>

diff --git a/docs/_build/html/documentation/observations.html b/docs/_build/html/documentation/observations.html
@@ -200,12 +200,16 @@
 <div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
   <p class="caption" role="heading"><span class="caption-text">Documentation</span></p>
 <ul class="current">
-<li class="toctree-l1"><a class="reference internal" href="simulator.html">SUMO simulator</a></li>
 <li class="toctree-l1"><a class="reference internal" href="pz_env.html">PettingZoo environment</a></li>
+<li class="toctree-l1"><a class="reference internal" href="simulator.html">SUMO simulator</a></li>
 <li class="toctree-l1"><a class="reference internal" href="machine_agents.html">Automated Vehicle (AV) agents</a></li>
 <li class="toctree-l1"><a class="reference internal" href="human_agents.html">Human drivers</a></li>
 <li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Observation functions</a></li>
 </ul>
+<p class="caption" role="heading"><span class="caption-text">Development</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference external" href="https://github.com/COeXISTENCE-PROJECT/Milestone-One">Github</a></li>
+</ul>
 
 </div>
 </div>

diff --git a/docs/_build/html/documentation/pz_env.html b/docs/_build/html/documentation/pz_env.html
@@ -3,7 +3,7 @@
   <head><meta charset="utf-8"/>
     <meta name="viewport" content="width=device-width,initial-scale=1"/>
     <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
-<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Automated Vehicle (AV) agents" href="machine_agents.html" /><link rel="prev" title="SUMO simulator" href="simulator.html" />
+<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="SUMO simulator" href="simulator.html" /><link rel="prev" title="RouteRL" href="../index.html" />
 
     <!-- Generated with Sphinx 8.0.2 and Furo 2024.08.06 -->
         <title>PettingZoo environment - RouteRL 0.0.1 documentation</title>
@@ -200,12 +200,16 @@
 <div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
   <p class="caption" role="heading"><span class="caption-text">Documentation</span></p>
 <ul class="current">
-<li class="toctree-l1"><a class="reference internal" href="simulator.html">SUMO simulator</a></li>
 <li class="toctree-l1 current current-page"><a class="current reference internal" href="#">PettingZoo environment</a></li>
+<li class="toctree-l1"><a class="reference internal" href="simulator.html">SUMO simulator</a></li>
 <li class="toctree-l1"><a class="reference internal" href="machine_agents.html">Automated Vehicle (AV) agents</a></li>
 <li class="toctree-l1"><a class="reference internal" href="human_agents.html">Human drivers</a></li>
 <li class="toctree-l1"><a class="reference internal" href="observations.html">Observation functions</a></li>
 </ul>
+<p class="caption" role="heading"><span class="caption-text">Development</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference external" href="https://github.com/COeXISTENCE-PROJECT/Milestone-One">Github</a></li>
+</ul>
 
 </div>
 </div>
@@ -422,23 +426,23 @@ <h1>PettingZoo environment<a class="headerlink" href="#pettingzoo-environment" t
       <footer>
 
         <div class="related-pages">
-          <a class="next-page" href="machine_agents.html">
+          <a class="next-page" href="simulator.html">
               <div class="page-info">
                 <div class="context">
                   <span>Next</span>
                 </div>
-                <div class="title">Automated Vehicle (AV) agents</div>
+                <div class="title">SUMO simulator</div>
               </div>
               <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
             </a>
-          <a class="prev-page" href="simulator.html">
+          <a class="prev-page" href="../index.html">
               <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
               <div class="page-info">
                 <div class="context">
                   <span>Previous</span>
                 </div>
 
-                <div class="title">SUMO simulator</div>
+                <div class="title">Home</div>
 
               </div>
             </a>

diff --git a/docs/_build/html/documentation/simulator.html b/docs/_build/html/documentation/simulator.html
@@ -3,7 +3,7 @@
   <head><meta charset="utf-8"/>
     <meta name="viewport" content="width=device-width,initial-scale=1"/>
     <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
-<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="PettingZoo environment" href="pz_env.html" /><link rel="prev" title="RouteRL" href="../index.html" />
+<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Automated Vehicle (AV) agents" href="machine_agents.html" /><link rel="prev" title="PettingZoo environment" href="pz_env.html" />
 
     <!-- Generated with Sphinx 8.0.2 and Furo 2024.08.06 -->
         <title>SUMO simulator - RouteRL 0.0.1 documentation</title>
@@ -200,12 +200,16 @@
 <div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
   <p class="caption" role="heading"><span class="caption-text">Documentation</span></p>
 <ul class="current">
-<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">SUMO simulator</a></li>
 <li class="toctree-l1"><a class="reference internal" href="pz_env.html">PettingZoo environment</a></li>
+<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">SUMO simulator</a></li>
 <li class="toctree-l1"><a class="reference internal" href="machine_agents.html">Automated Vehicle (AV) agents</a></li>
 <li class="toctree-l1"><a class="reference internal" href="human_agents.html">Human drivers</a></li>
 <li class="toctree-l1"><a class="reference internal" href="observations.html">Observation functions</a></li>
 </ul>
+<p class="caption" role="heading"><span class="caption-text">Development</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference external" href="https://github.com/COeXISTENCE-PROJECT/Milestone-One">Github</a></li>
+</ul>
 
 </div>
 </div>
@@ -303,23 +307,23 @@ <h1>SUMO simulator<a class="headerlink" href="#sumo-simulator" title="Link to th
       <footer>
 
         <div class="related-pages">
-          <a class="next-page" href="pz_env.html">
+          <a class="next-page" href="machine_agents.html">
               <div class="page-info">
                 <div class="context">
                   <span>Next</span>
                 </div>
-                <div class="title">PettingZoo environment</div>
+                <div class="title">Automated Vehicle (AV) agents</div>
               </div>
               <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
             </a>
-          <a class="prev-page" href="../index.html">
+          <a class="prev-page" href="pz_env.html">
               <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
               <div class="page-info">
                 <div class="context">
                   <span>Previous</span>
                 </div>
 
-                <div class="title">Home</div>
+                <div class="title">PettingZoo environment</div>
 
               </div>
             </a>

diff --git a/docs/_build/html/genindex.html b/docs/_build/html/genindex.html
@@ -198,12 +198,16 @@
 <div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
   <p class="caption" role="heading"><span class="caption-text">Documentation</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="documentation/simulator.html">SUMO simulator</a></li>
 <li class="toctree-l1"><a class="reference internal" href="documentation/pz_env.html">PettingZoo environment</a></li>
+<li class="toctree-l1"><a class="reference internal" href="documentation/simulator.html">SUMO simulator</a></li>
 <li class="toctree-l1"><a class="reference internal" href="documentation/machine_agents.html">Automated Vehicle (AV) agents</a></li>
 <li class="toctree-l1"><a class="reference internal" href="documentation/human_agents.html">Human drivers</a></li>
 <li class="toctree-l1"><a class="reference internal" href="documentation/observations.html">Observation functions</a></li>
 </ul>
+<p class="caption" role="heading"><span class="caption-text">Development</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference external" href="https://github.com/COeXISTENCE-PROJECT/Milestone-One">Github</a></li>
+</ul>
 
 </div>
 </div>