Update documentation

This commit is contained in:
Joel Klimont 2022-11-09 02:35:50 +01:00
parent 581cfd394a
commit 4cef171e99
6 changed files with 25 additions and 2 deletions

View file

@ -8,3 +8,5 @@ Dokumentation des Seeding Moduls
.. autoclass:: compLib.Seeding.Gamestate
:members:
.. automethod:: __init__

View file

@ -74,7 +74,8 @@
<h1 id="index">Stichwortverzeichnis</h1>
<div class="genindex-jumpbox">
<a href="#D"><strong>D</strong></a>
<a href="#_"><strong>_</strong></a>
| <a href="#D"><strong>D</strong></a>
| <a href="#E"><strong>E</strong></a>
| <a href="#G"><strong>G</strong></a>
| <a href="#I"><strong>I</strong></a>
@ -84,6 +85,14 @@
| <a href="#S"><strong>S</strong></a>
</div>
<h2 id="_">_</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="lib/classes/Seeding.html#compLib.Seeding.Gamestate.__init__">__init__() (Methode von compLib.Seeding.Gamestate)</a>
</li>
</ul></td>
</tr></table>
<h2 id="D">D</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>

View file

@ -96,6 +96,17 @@
<dt class="sig sig-object py" id="compLib.Seeding.Gamestate">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">compLib.Seeding.</span></span><span class="sig-name descname"><span class="pre">Gamestate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">seed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#compLib.Seeding.Gamestate" title="Link zu dieser Definition"></a></dt>
<dd><dl class="py method">
<dt class="sig sig-object py" id="compLib.Seeding.Gamestate.__init__">
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">seed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#compLib.Seeding.Gamestate.__init__" title="Link zu dieser Definition"></a></dt>
<dd><p>Erstellt den Seeding Gamestate für den angegebenen Seed.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameter</dt>
<dd class="field-odd"><p><strong>seed</strong> Seed welcher zum erstellen des Gamestates benutzt werden soll.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="compLib.Seeding.Gamestate.get_heuballen">
<span class="sig-name descname"><span class="pre">get_heuballen</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#compLib.Seeding.Gamestate.get_heuballen" title="Link zu dieser Definition"></a></dt>
<dd><p>Die Funktion gibt entweder die Zahl „1“ oder „2“ zurück. Wenn die Funktion „1“ zurückgibt, dann liegen die Heuballen auf den gelben Linien. Wenn die Funktion „2“ zurückgibt, dann liegen sie auf den blauen Flächen.</p>

View file

@ -135,6 +135,7 @@
<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-des-seeding-moduls">Dokumentation des Seeding Moduls</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><ul>
<li class="toctree-l4"><a class="reference internal" href="classes/Seeding.html#compLib.Seeding.Gamestate.__init__"><code class="docutils literal notranslate"><span class="pre">Gamestate.__init__()</span></code></a></li>
<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>

Binary file not shown.

File diff suppressed because one or more lines are too long