Update documentation

This commit is contained in:
Joel Klimont 2022-11-09 02:13:43 +01:00
parent cab339c556
commit a4839b8121
10 changed files with 285 additions and 8 deletions

View file

@ -21,7 +21,7 @@
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Stichwortverzeichnis" href="../genindex.html" />
<link rel="search" title="Suche" href="../search.html" />
<link rel="next" title="Encoder" href="classes/Encoder.html" />
<link rel="next" title="Double Elimination" href="classes/DoubleElimination.html" />
<link rel="prev" title="Beispiele" href="../other/usage.html" />
</head>
@ -47,6 +47,7 @@
<li class="toctree-l1"><a class="reference internal" href="../faq.html">FAQ</a></li>
<li class="toctree-l1"><a class="reference internal" href="../other/usage.html">Beispiele</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">compLib</a><ul>
<li class="toctree-l2"><a class="reference internal" href="classes/DoubleElimination.html">Double Elimination</a></li>
<li class="toctree-l2"><a class="reference internal" href="classes/Encoder.html">Encoder</a></li>
<li class="toctree-l2"><a class="reference internal" href="classes/IRSensor.html">Infrarot Sensoren</a></li>
<li class="toctree-l2"><a class="reference internal" href="classes/Motor.html">Motoren</a></li>
@ -84,6 +85,21 @@
<h1>compLib<a class="headerlink" href="#complib" title="Permalink to this heading"></a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="classes/DoubleElimination.html">Double Elimination</a><ul>
<li class="toctree-l2"><a class="reference internal" href="classes/DoubleElimination.html#dokumentation-der-klasse">Dokumentation der Klasse</a><ul>
<li class="toctree-l3"><a class="reference internal" href="classes/DoubleElimination.html#compLib.DoubleElimination.Position"><code class="docutils literal notranslate"><span class="pre">Position</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="classes/DoubleElimination.html#compLib.DoubleElimination.DoubleElim"><code class="docutils literal notranslate"><span class="pre">DoubleElim</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="classes/DoubleElimination.html#compLib.DoubleElimination.DoubleElim.get_goal"><code class="docutils literal notranslate"><span class="pre">DoubleElim.get_goal()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="classes/DoubleElimination.html#compLib.DoubleElimination.DoubleElim.get_items"><code class="docutils literal notranslate"><span class="pre">DoubleElim.get_items()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="classes/DoubleElimination.html#compLib.DoubleElimination.DoubleElim.get_opponent"><code class="docutils literal notranslate"><span class="pre">DoubleElim.get_opponent()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="classes/DoubleElimination.html#compLib.DoubleElimination.DoubleElim.get_pos"><code class="docutils literal notranslate"><span class="pre">DoubleElim.get_pos()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="classes/DoubleElimination.html#compLib.DoubleElimination.DoubleElim.get_scores"><code class="docutils literal notranslate"><span class="pre">DoubleElim.get_scores()</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="classes/Encoder.html">Encoder</a><ul>
<li class="toctree-l2"><a class="reference internal" href="classes/Encoder.html#dokumentation-der-klasse">Dokumentation der Klasse</a><ul>
<li class="toctree-l3"><a class="reference internal" href="classes/Encoder.html#compLib.Encoder.Encoder"><code class="docutils literal notranslate"><span class="pre">Encoder</span></code></a><ul>
@ -133,7 +149,12 @@
</li>
<li class="toctree-l1"><a class="reference internal" href="classes/Seeding.html">Seeding</a><ul>
<li class="toctree-l2"><a class="reference internal" href="classes/Seeding.html#dokumentation-der-klasse">Dokumentation der Klasse</a><ul>
<li class="toctree-l3"><a class="reference internal" href="classes/Seeding.html#compLib.Seeding.Gamestate"><code class="docutils literal notranslate"><span class="pre">Gamestate</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="classes/Seeding.html#compLib.Seeding.Gamestate"><code class="docutils literal notranslate"><span class="pre">Gamestate</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="classes/Seeding.html#compLib.Seeding.Gamestate.get_heuballen"><code class="docutils literal notranslate"><span class="pre">Gamestate.get_heuballen()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="classes/Seeding.html#compLib.Seeding.Gamestate.get_logistic_plan"><code class="docutils literal notranslate"><span class="pre">Gamestate.get_logistic_plan()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="classes/Seeding.html#compLib.Seeding.Gamestate.get_material_deliveries"><code class="docutils literal notranslate"><span class="pre">Gamestate.get_material_deliveries()</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
@ -147,7 +168,7 @@
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="../other/usage.html" class="btn btn-neutral float-left" title="Beispiele" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Zurück</a>
<a href="classes/Encoder.html" class="btn btn-neutral float-right" title="Encoder" accesskey="n" rel="next">Weiter <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="classes/DoubleElimination.html" class="btn btn-neutral float-right" title="Double Elimination" accesskey="n" rel="next">Weiter <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>