Update documentation

_sources/lib/classes/Seeding.rst.txt

@@ -10,3 +10,29 @@ Dokumentation des Seeding Moduls
    :members:
 
    .. automethod:: __init__
+
+Beispiele
+----------
+
+| In ``Zeile 1`` wird das Seeding Modul importiert.
+| In ``Zeile 2`` definieren wir dann eine Variable, in der wir den "Seed" des Gamestates den wir erstellen wollten speichern.
+| In ``Zeile 3`` erstellen wir dann einen neuen Gamestate mit dem Seed und speichern ihn in die Variable ``gamestate``.
+| In ``Zeile 4`` geben wir dann den Gamestate aus, damit wir ihn auf der Konsole ansehen können.
+
+.. code-block:: python
+
+    import compLib.Seeding as Seeding
+    seed = 42
+    gamestate = Seeding.Gamestate(seed)
+    print(gamestate)
+
+In der Ausgabe des Print Statements sehen wir den generierten Gamestate.
+
+.. code-block::
+
+    Seed: 42
+    Heu Color: 1
+    Material Pairs: [[3, 0], [2, 3], [0, 2], [1, 2]]
+    Material Zones: [2, 1, 3, 2]
+    Logistic Plan: [12, 13, 12, 13, 10, 11, 13, 10, 13, 12, 11, 10, 11, 13, 10, 11, 12, 11, 12, 10, 12]
+    Logistic Centers: [[0, 3, 1, 1], [1, 0, 2, 2], [1, 2, 0, 2], [3, 0, 2, 0]]

lib/classes/Motor.html

@@ -122,7 +122,7 @@
 <dl class="py method">
 <dt class="sig sig-object py" id="compLib.Motor.Motor.multiple_pulse_width">
 <em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">multiple_pulse_width</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">arguments</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#compLib.Motor.Motor.multiple_pulse_width" title="Link zu dieser Definition"></a></dt>
-<dd><p>Setzen den Pulsbreite mehreer Motoren in Prozent der Periode</p>
+<dd><p>Setzen den Pulsbreite mehrerer Motoren in Prozent der Periode</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameter</dt>
 <dd class="field-odd"><p><strong>arguments</strong> – tuple von port, prozent</p>
@@ -154,7 +154,7 @@
 <dl class="field-list simple">
 <dt class="field-odd">Parameter</dt>
 <dd class="field-odd"><ul class="simple">
-<li><p><strong>port</strong> – Port, an welchen der Motor angestecht wird. 0-3</p></li>
+<li><p><strong>port</strong> – Port, an welchen der Motor angesteckt ist. 0-3</p></li>
 <li><p><strong>percent</strong> – Prozentsatz der Höchstgeschwindigkeit. zwischen -100 und 100</p></li>
 </ul>
 </dd>
@@ -171,7 +171,7 @@
 <dl class="field-list simple">
 <dt class="field-odd">Parameter</dt>
 <dd class="field-odd"><ul class="simple">
-<li><p><strong>port</strong> – Port, an welchen der Motor angestecht wird. 0-3</p></li>
+<li><p><strong>port</strong> – Port, an welchen der Motor angesteckt ist. 0-3</p></li>
 <li><p><strong>percent</strong> – Prozent der Periode zwischen -100 und 100</p></li>
 </ul>
 </dd>
@@ -188,7 +188,7 @@
 <dl class="field-list simple">
 <dt class="field-odd">Parameter</dt>
 <dd class="field-odd"><ul class="simple">
-<li><p><strong>port</strong> – Port, an welchen der Motor angestecht wird. 0-3</p></li>
+<li><p><strong>port</strong> – Port, an welchen der Motor angesteckt ist. 0-3</p></li>
 <li><p><strong>speed</strong> – Drehzahl, mit der sich ein Motor dreht, in Radianten pro Sekunde (rad/s)</p></li>
 </ul>
 </dd>

lib/classes/Seeding.html

@@ -53,6 +53,7 @@
 <li class="toctree-l2 current"><a class="current reference internal" href="#">Seeding</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="#dokumentation-des-seeding-moduls">Dokumentation des Seeding Moduls</a><ul>
 <li class="toctree-l4"><a class="reference internal" href="#compLib.Seeding.Gamestate"><code class="docutils literal notranslate"><span class="pre">Gamestate</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#beispiele">Beispiele</a></li>
 </ul>
 </li>
 </ul>
@@ -98,7 +99,7 @@
 <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 class="field-odd"><p><strong>seed</strong> – Seed welcher zum Erstellen des Gamestates benutzt werden soll.</p>
 </dd>
 </dl>
 <dl class="py method">
@@ -107,7 +108,7 @@
 <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 class="field-odd"><p><strong>seed</strong> – Seed welcher zum Erstellen des Gamestates benutzt werden soll.</p>
 </dd>
 </dl>
 </dd></dl>
@@ -147,6 +148,30 @@
 
 </dd></dl>
 
+<section id="beispiele">
+<h3>Beispiele<a class="headerlink" href="#beispiele" title="Permalink to this heading"></a></h3>
+<div class="line-block">
+<div class="line">In <code class="docutils literal notranslate"><span class="pre">Zeile</span> <span class="pre">1</span></code> wird das Seeding Modul importiert.</div>
+<div class="line">In <code class="docutils literal notranslate"><span class="pre">Zeile</span> <span class="pre">2</span></code> definieren wir dann eine Variable, in der wir den „Seed“ des Gamestates den wir erstellen wollten speichern.</div>
+<div class="line">In <code class="docutils literal notranslate"><span class="pre">Zeile</span> <span class="pre">3</span></code> erstellen wir dann einen neuen Gamestate mit dem Seed und speichern ihn in die Variable <code class="docutils literal notranslate"><span class="pre">gamestate</span></code>.</div>
+<div class="line">In <code class="docutils literal notranslate"><span class="pre">Zeile</span> <span class="pre">4</span></code> geben wir dann den Gamestate aus, damit wir ihn auf der Konsole ansehen können.</div>
+</div>
+<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">compLib.Seeding</span> <span class="k">as</span> <span class="nn">Seeding</span>
+<span class="n">seed</span> <span class="o">=</span> <span class="mi">42</span>
+<span class="n">gamestate</span> <span class="o">=</span> <span class="n">Seeding</span><span class="o">.</span><span class="n">Gamestate</span><span class="p">(</span><span class="n">seed</span><span class="p">)</span>
+<span class="nb">print</span><span class="p">(</span><span class="n">gamestate</span><span class="p">)</span>
+</pre></div>
+</div>
+<p>In der Ausgabe des Print Statements sehen wir den generierten Gamestate.</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Seed</span><span class="p">:</span> <span class="mi">42</span>
+<span class="n">Heu</span> <span class="n">Color</span><span class="p">:</span> <span class="mi">1</span>
+<span class="n">Material</span> <span class="n">Pairs</span><span class="p">:</span> <span class="p">[[</span><span class="mi">3</span><span class="p">,</span> <span class="mi">0</span><span class="p">],</span> <span class="p">[</span><span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">],</span> <span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="mi">2</span><span class="p">],</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">]]</span>
+<span class="n">Material</span> <span class="n">Zones</span><span class="p">:</span> <span class="p">[</span><span class="mi">2</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">2</span><span class="p">]</span>
+<span class="n">Logistic</span> <span class="n">Plan</span><span class="p">:</span> <span class="p">[</span><span class="mi">12</span><span class="p">,</span> <span class="mi">13</span><span class="p">,</span> <span class="mi">12</span><span class="p">,</span> <span class="mi">13</span><span class="p">,</span> <span class="mi">10</span><span class="p">,</span> <span class="mi">11</span><span class="p">,</span> <span class="mi">13</span><span class="p">,</span> <span class="mi">10</span><span class="p">,</span> <span class="mi">13</span><span class="p">,</span> <span class="mi">12</span><span class="p">,</span> <span class="mi">11</span><span class="p">,</span> <span class="mi">10</span><span class="p">,</span> <span class="mi">11</span><span class="p">,</span> <span class="mi">13</span><span class="p">,</span> <span class="mi">10</span><span class="p">,</span> <span class="mi">11</span><span class="p">,</span> <span class="mi">12</span><span class="p">,</span> <span class="mi">11</span><span class="p">,</span> <span class="mi">12</span><span class="p">,</span> <span class="mi">10</span><span class="p">,</span> <span class="mi">12</span><span class="p">]</span>
+<span class="n">Logistic</span> <span class="n">Centers</span><span class="p">:</span> <span class="p">[[</span><span class="mi">0</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">],</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">2</span><span class="p">],</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">2</span><span class="p">],</span> <span class="p">[</span><span class="mi">3</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">0</span><span class="p">]]</span>
+</pre></div>
+</div>
+</section>
 </section>
 </section>
 

lib/index.html

@@ -141,6 +141,7 @@
 <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>
+<li class="toctree-l3"><a class="reference internal" href="classes/Seeding.html#beispiele">Beispiele</a></li>
 </ul>
 </li>
 </ul>