Update documentation

This commit is contained in:
Konstantin Lampalzer 2021-09-13 19:14:30 +02:00
parent 4c1cfa6735
commit fbf455c5b7
19 changed files with 230 additions and 42 deletions

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 188 KiB

View file

@ -1,14 +1,12 @@
Robo4you Competition Library
.. image:: images/compair-logo-white.svg
Competition Robot Library
#############################
.. toctree::
:maxdepth: 2
:caption: Contents:
CompLib is the library used in the robo4you competition 2021.
Contents
*********

View file

@ -9,12 +9,13 @@ Usage
from compLib.Motor import *
def forward():
for port in range(0, 4):
Motor.power(port, 30);
Motor.power(1, -30);
Motor.power(2, 30);
def backward():
for port in range(0, 4):
Motor.power(port, -30);
Motor.power(1, 30);
Motor.power(2, -30);
def main():
print("hallo ich bin ein roboter beep buup")

View file

@ -80,7 +80,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="index.html">Robo4you Competition Library</a></li>
<li class="toctree-l1"><a class="reference internal" href="index.html">Competition Robot Library</a></li>
<li class="toctree-l1"><a class="reference internal" href="other/usage.html">Usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="lib/Api.html">Api</a></li>
<li class="toctree-l1"><a class="reference internal" href="lib/Aruco.html">Aruco</a></li>

View file

@ -7,7 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Robo4you Competition Library &mdash; CompLib 0.0.2 documentation</title>
<title>Competition Robot Library &mdash; CompLib 0.0.2 documentation</title>
@ -81,7 +81,7 @@
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Robo4you Competition Library</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Competition Robot Library</a></li>
<li class="toctree-l1"><a class="reference internal" href="other/usage.html">Usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="lib/Api.html">Api</a></li>
<li class="toctree-l1"><a class="reference internal" href="lib/Aruco.html">Aruco</a></li>
@ -139,7 +139,7 @@
<li><a href="#" class="icon icon-home"></a> &raquo;</li>
<li>Robo4you Competition Library</li>
<li>Competition Robot Library</li>
<li class="wy-breadcrumbs-aside">
@ -158,16 +158,15 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="robo4you-competition-library">
<h1>Robo4you Competition Library<a class="headerlink" href="#robo4you-competition-library" title="Permalink to this headline"></a></h1>
<img alt="_images/compair-logo-white.svg" src="_images/compair-logo-white.svg" /><div class="section" id="competition-robot-library">
<h1>Competition Robot Library<a class="headerlink" href="#competition-robot-library" title="Permalink to this headline"></a></h1>
<div class="toctree-wrapper compound">
</div>
<p>CompLib is the library used in the robo4you competition 2021.</p>
<div class="section" id="contents">
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Robo4you Competition Library</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Competition Robot Library</a></li>
<li class="toctree-l1"><a class="reference internal" href="other/usage.html">Usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="lib/Api.html">Api</a><ul>
<li class="toctree-l2"><a class="reference internal" href="lib/Api.html#seeding">Seeding</a></li>

View file

@ -82,7 +82,7 @@
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../index.html">Robo4you Competition Library</a></li>
<li class="toctree-l1"><a class="reference internal" href="../index.html">Competition Robot Library</a></li>
<li class="toctree-l1"><a class="reference internal" href="../other/usage.html">Usage</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Api</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#seeding">Seeding</a></li>

View file

@ -82,7 +82,7 @@
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../index.html">Robo4you Competition Library</a></li>
<li class="toctree-l1"><a class="reference internal" href="../index.html">Competition Robot Library</a></li>
<li class="toctree-l1"><a class="reference internal" href="../other/usage.html">Usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="Api.html">Api</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Aruco</a><ul>

View file

@ -82,7 +82,7 @@
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../index.html">Robo4you Competition Library</a></li>
<li class="toctree-l1"><a class="reference internal" href="../index.html">Competition Robot Library</a></li>
<li class="toctree-l1"><a class="reference internal" href="../other/usage.html">Usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="Api.html">Api</a></li>
<li class="toctree-l1"><a class="reference internal" href="Aruco.html">Aruco</a></li>
@ -182,7 +182,7 @@
<dl class="py method">
<dt id="compLib.Display.Display.write">
<em class="property">static </em><code class="sig-name descname">write</code><span class="sig-paren">(</span><em class="sig-param">line: int</em>, <em class="sig-param">text: &lt;module 'string' from '/usr/local/Cellar/python&#64;3.9/3.9.6/Frameworks/Python.framework/Versions/3.9/lib/python3.9/string.py'&gt;</em><span class="sig-paren">)</span><a class="headerlink" href="#compLib.Display.Display.write" title="Permalink to this definition"></a></dt>
<em class="property">static </em><code class="sig-name descname">write</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">line</span><span class="p">:</span> <span class="n">int</span></em>, <em class="sig-param"><span class="n">text</span><span class="p">:</span> <span class="n">str</span></em><span class="sig-paren">)</span><a class="headerlink" href="#compLib.Display.Display.write" title="Permalink to this definition"></a></dt>
<dd><p>Write a string of text to the integrated display.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>

View file

@ -82,7 +82,7 @@
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../index.html">Robo4you Competition Library</a></li>
<li class="toctree-l1"><a class="reference internal" href="../index.html">Competition Robot Library</a></li>
<li class="toctree-l1"><a class="reference internal" href="../other/usage.html">Usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="Api.html">Api</a></li>
<li class="toctree-l1"><a class="reference internal" href="Aruco.html">Aruco</a></li>

View file

@ -82,7 +82,7 @@
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../index.html">Robo4you Competition Library</a></li>
<li class="toctree-l1"><a class="reference internal" href="../index.html">Competition Robot Library</a></li>
<li class="toctree-l1"><a class="reference internal" href="../other/usage.html">Usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="Api.html">Api</a></li>
<li class="toctree-l1"><a class="reference internal" href="Aruco.html">Aruco</a></li>

View file

@ -82,7 +82,7 @@
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../index.html">Robo4you Competition Library</a></li>
<li class="toctree-l1"><a class="reference internal" href="../index.html">Competition Robot Library</a></li>
<li class="toctree-l1"><a class="reference internal" href="../other/usage.html">Usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="Api.html">Api</a></li>
<li class="toctree-l1"><a class="reference internal" href="Aruco.html">Aruco</a></li>

View file

@ -82,7 +82,7 @@
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../index.html">Robo4you Competition Library</a></li>
<li class="toctree-l1"><a class="reference internal" href="../index.html">Competition Robot Library</a></li>
<li class="toctree-l1"><a class="reference internal" href="../other/usage.html">Usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="Api.html">Api</a></li>
<li class="toctree-l1"><a class="reference internal" href="Aruco.html">Aruco</a></li>

View file

@ -82,7 +82,7 @@
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../index.html">Robo4you Competition Library</a></li>
<li class="toctree-l1"><a class="reference internal" href="../index.html">Competition Robot Library</a></li>
<li class="toctree-l1"><a class="reference internal" href="../other/usage.html">Usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="Api.html">Api</a></li>
<li class="toctree-l1"><a class="reference internal" href="Aruco.html">Aruco</a></li>

View file

@ -82,7 +82,7 @@
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../index.html">Robo4you Competition Library</a></li>
<li class="toctree-l1"><a class="reference internal" href="../index.html">Competition Robot Library</a></li>
<li class="toctree-l1"><a class="reference internal" href="../other/usage.html">Usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="Api.html">Api</a></li>
<li class="toctree-l1"><a class="reference internal" href="Aruco.html">Aruco</a></li>

View file

@ -81,7 +81,7 @@
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../index.html">Robo4you Competition Library</a></li>
<li class="toctree-l1"><a class="reference internal" href="../index.html">Competition Robot Library</a></li>
<li class="toctree-l1"><a class="reference internal" href="../other/usage.html">Usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="Api.html">Api</a></li>
<li class="toctree-l1"><a class="reference internal" href="Aruco.html">Aruco</a></li>

View file

@ -2,8 +2,8 @@
# Project: CompLib
# Version:
# The remainder of this file is compressed using zlib.
¥Ko£0Çï|
KÝkRUÚSo«m•ºRÔh÷j˜k F¶IÊ·_?xØ@7†^Â`ÿãÇLfÈxY¿Ñtÿ£¦ûÞ¤ Œ¨nŸ3F¤DOˆÑôÑÌ^Tɾ¡]-"û.8a†-A]x¾¦
J¹™æuÍ+¨Ôf5—TQ^mv 3.`ÅŽÞQ—}ÈiU¬Õ»Óñ7~k=Y“v#)iÉ+,Iy!/TÖŒ´ýszÆ~ú·Ï1[2¿ <09>…ñø¡Êx¢NwÝOßã>Ùõ:ƶ»@ò¯ÑX<C391>[¼‡×÷TÁ˜ÞÝ ¸<>.o~<7E> jÿÆ ©ˆ¼ègar½{NOÐOÇòöÊ´ óTXíKŸç<>6E¼«_\éÓÚßéQÜÔÿˆ½Nu,æå"†g óóy ­4Îq…-.j~[¸õXp1õcà[¹“ÛÎû‡JÝmöŸ”<52>±<EFBFBD>"´w~¤œ¯¾ÂI­û'•—HGT´ÊáI•?3C»'Ô<>Zz5f2Êrž§xç)ÿÞòýÔûå:°ÞŸ ¢Mºöä£~ÇBÚpÑd|¦2ƒ<32>Θ×:¦Z¿£ î%ñ
æTï×QÔ½$~•šAõÒ×¢¯X@ŽÜ %ßh˜Íü íÏ9<0F>úðAÊš<C38A>L¼z2sá•Ô½$CvNÕcÊ"kZå ÄuvËvÐ)­™Œ©2•z „œmĘtR(ø(Ñ/;£èB<C3A8>s/€|ªWzáÄà…3 ƒÆhè^éS!ÇàxØœ ?hb<>Ù4Ö<34>³Y´­Ã€ù4ü¶aõá½ú}Æ:ì”^2¸26g½
fH§Ë!1jL K9Õ<39>$ø:&I€ùuÆp<C386>®Ë˜ç U§nwýDŸµyà«?\]@<6àç¤7ì ßÆtj<ª‡E¦ú;°sJÇzû¸³Ác«KkîSêÏÆìn¬ÿƒÙù£YéæèôÙ
ĄMoŁ0†ďü
KÝkRőÚŰjŰCĄ®5Ú˝Z&ÄZ<C384>í$ĺ߯?0؆n€˝„Á~źńÇLf(xÝľÓ|˙˝ĄűĽ2Zٶ{.=!FóG3{V5{ř†vY1ě+P¸â„ućĺJ<C4BA>*¨ĺfš·-o Q´\REyłŮ<C582>,¸€8 .şě#@Ij­ŢťŽ<C5A5>?Ë·ćÉtIIkŢ`Iş…ňBeËHçźéýô=n_0 b˛äbü&t.Ç_— ü3ݵźľÇ}±ëu8&Śmw!€”˙GcAnË=Ľ}ˇ‘\ Fzw<7A>ŕ>:żů5ü;ݤ"ň¬ź•Éőţ™žŔO/ĺí˙”i¦©°Ú—>.!żTË]ýäJźÖţ¦GqS˙"ö¤Pô
8×±<EFBFBD>%<c<>źN[Psoµ±pqWŘâ˘ĺ·™[_
ΦţřVoÁä¶óţ¦Rw=ĆGĄ<47>TĎdlŻX@Ú;? ROW_á¤Őý“ĘóBG4´IU>3C»'äG­˝3e%/Ś(PüĐŰĺďĎąBzs<73>.ë{SČ…í
iĂiÄĄŕěuĆĚľjĂvú—,¨–©>,˘¨ÉÂQéŇw˘ďW@‰Ü %ßi<>Mű„眇HýúIę<C499>Ěb2qÔÔżdCj¦ę1_5­ňâ:ąe;č”ÖĚĆ<IĄAö g1&}€‡ü‰ľHôËÎ(úPă2`DD_†ňĘ śpFtÔ í•Ap1r n„ÇťÉđ<C389>v&Ö<>Ą±ŽśM˘mFĚ—á·Ýʇ?ö6ë°WÉŕjŘ” Ę—!ťjH ,‡Ä<E280A1>¨15,ĺTCŕë<C595>$Ăőş>cj^Δś¶Űů źµĺ…A_|¸:<3A>xĽHRA<52>“Á°<C381>~Ó©ń¨v`甎 öqg<71>‡N×Ő&ާÔߌĹ9Ý<>˙<EFBFBD>Ůů<C5AE>Yé/ĚúóĽ

View file

@ -36,7 +36,7 @@
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Api" href="../lib/Api.html" />
<link rel="prev" title="Robo4you Competition Library" href="../index.html" />
<link rel="prev" title="Competition Robot Library" href="../index.html" />
</head>
<body class="wy-body-for-nav">
@ -82,7 +82,7 @@
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../index.html">Robo4you Competition Library</a></li>
<li class="toctree-l1"><a class="reference internal" href="../index.html">Competition Robot Library</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="../lib/Api.html">Api</a></li>
<li class="toctree-l1"><a class="reference internal" href="../lib/Aruco.html">Aruco</a></li>
@ -165,12 +165,13 @@
<span class="kn">from</span> <span class="nn">compLib.Motor</span> <span class="kn">import</span> <span class="o">*</span>
<span class="k">def</span> <span class="nf">forward</span><span class="p">():</span>
<span class="k">for</span> <span class="n">port</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">4</span><span class="p">):</span>
<span class="n">Motor</span><span class="o">.</span><span class="n">power</span><span class="p">(</span><span class="n">port</span><span class="p">,</span> <span class="mi">30</span><span class="p">);</span>
<span class="n">Motor</span><span class="o">.</span><span class="n">power</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="o">-</span><span class="mi">30</span><span class="p">);</span>
<span class="n">Motor</span><span class="o">.</span><span class="n">power</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="mi">30</span><span class="p">);</span>
<span class="k">def</span> <span class="nf">backward</span><span class="p">():</span>
<span class="k">for</span> <span class="n">port</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">4</span><span class="p">):</span>
<span class="n">Motor</span><span class="o">.</span><span class="n">power</span><span class="p">(</span><span class="n">port</span><span class="p">,</span> <span class="o">-</span><span class="mi">30</span><span class="p">);</span>
<span class="n">Motor</span><span class="o">.</span><span class="n">power</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">30</span><span class="p">);</span>
<span class="n">Motor</span><span class="o">.</span><span class="n">power</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="o">-</span><span class="mi">30</span><span class="p">);</span>
<span class="k">def</span> <span class="nf">main</span><span class="p">():</span>
<span class="nb">print</span><span class="p">(</span><span class="s2">&quot;hallo ich bin ein roboter beep buup&quot;</span><span class="p">)</span>
@ -197,7 +198,7 @@
<a href="../lib/Api.html" class="btn btn-neutral float-right" title="Api" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="../index.html" class="btn btn-neutral float-left" title="Robo4you Competition Library" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
<a href="../index.html" class="btn btn-neutral float-left" title="Competition Robot Library" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>

View file

@ -82,7 +82,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="index.html">Robo4you Competition Library</a></li>
<li class="toctree-l1"><a class="reference internal" href="index.html">Competition Robot Library</a></li>
<li class="toctree-l1"><a class="reference internal" href="other/usage.html">Usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="lib/Api.html">Api</a></li>
<li class="toctree-l1"><a class="reference internal" href="lib/Aruco.html">Aruco</a></li>

File diff suppressed because one or more lines are too long