Update documentation

This commit is contained in:
Joel 2021-01-17 04:35:51 +01:00
parent 0dbfc5fe6b
commit aa6fb2fc8b
No known key found for this signature in database
GPG key ID: BDDDBECD0808290E
17 changed files with 776 additions and 47 deletions

View file

@ -7,7 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Welcome to CompLibs documentation! &mdash; CompLib 0.0.1 documentation</title>
<title>Robo4you Competition Library &mdash; CompLib 0.0.2 documentation</title>
@ -38,7 +38,7 @@
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Battery" href="lib/Battery.html" />
<link rel="next" title="Usage" href="other/usage.html" />
</head>
<body class="wy-body-for-nav">
@ -84,7 +84,9 @@
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Welcome to CompLibs documentation!</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Robo4you Competition 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/Battery.html">Battery</a></li>
<li class="toctree-l1"><a class="reference internal" href="lib/Buzzer.html">Buzzer</a></li>
<li class="toctree-l1"><a class="reference internal" href="lib/IRSensor.html">Infrared Sensor</a></li>
@ -138,7 +140,7 @@
<li><a href="#" class="icon icon-home"></a> &raquo;</li>
<li>Welcome to CompLibs documentation!</li>
<li>Robo4you Competition Library</li>
<li class="wy-breadcrumbs-aside">
@ -157,23 +159,28 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="welcome-to-complib-s-documentation">
<h1>Welcome to CompLibs documentation!<a class="headerlink" href="#welcome-to-complib-s-documentation" title="Permalink to this headline"></a></h1>
<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>
<div class="toctree-wrapper compound">
</div>
</div>
<div class="section" id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline"></a></h1>
<ul class="simple">
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
</ul>
<div class="section" id="table-of-contents">
<h2>Table of Contents<a class="headerlink" href="#table-of-contents" title="Permalink to this headline"></a></h2>
<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="#">Welcome to CompLibs documentation!</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Robo4you Competition 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>
<li class="toctree-l2"><a class="reference internal" href="lib/Api.html#double-elimination">Double Elimination</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/Api.html#position">Position</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/Api.html#examples">Examples</a><ul>
<li class="toctree-l3"><a class="reference internal" href="lib/Api.html#calling-seeding-api">Calling Seeding API</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/Api.html#calling-double-elimination-api">Calling Double Elimination API</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="lib/Battery.html">Battery</a><ul>
<li class="toctree-l2"><a class="reference internal" href="lib/Battery.html#class-documentation">Class Documentation</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/Battery.html#examples">Examples</a><ul>
@ -211,7 +218,7 @@
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="lib/Battery.html" class="btn btn-neutral float-right" title="Battery" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="other/usage.html" class="btn btn-neutral float-right" title="Usage" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>