Update documentation

This commit is contained in:
Konstantin Lampalzer 2021-01-16 01:55:10 +01:00
parent d39ad4b112
commit d555d55b2c
No known key found for this signature in database
GPG key ID: 9A60A522835A2AD9
8 changed files with 151 additions and 13 deletions

View file

@ -83,7 +83,14 @@
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../index.html">Welcome to CompLibs documentation!</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Battery</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Battery</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#class-documentation">Class Documentation</a></li>
<li class="toctree-l2"><a class="reference internal" href="#examples">Examples</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#printing-percentage">Printing percentage</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Buzzer.html">Buzzer</a></li>
<li class="toctree-l1"><a class="reference internal" href="IRSensor.html">Infrared Sensor</a></li>
<li class="toctree-l1"><a class="reference internal" href="Motor.html">Motor</a></li>
@ -155,6 +162,8 @@
<div class="section" id="battery">
<span id="lib-battery"></span><h1>Battery<a class="headerlink" href="#battery" title="Permalink to this headline"></a></h1>
<div class="section" id="class-documentation">
<h2>Class Documentation<a class="headerlink" href="#class-documentation" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt id="compLIB.Battery.Battery">
<em class="property">class </em><code class="sig-prename descclassname">compLIB.Battery.</code><code class="sig-name descname">Battery</code><a class="headerlink" href="#compLIB.Battery.Battery" title="Permalink to this definition"></a></dt>
@ -175,6 +184,18 @@
</dd></dl>
</div>
<div class="section" id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="section" id="printing-percentage">
<h3>Printing percentage<a class="headerlink" href="#printing-percentage" title="Permalink to this headline"></a></h3>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">compLIB.Battery</span> <span class="kn">import</span> <span class="n">Battery</span>
<span class="nb">print</span><span class="p">(</span><span class="n">Battery</span><span class="o">.</span><span class="n">percent</span><span class="p">())</span>
</pre></div>
</div>
</div>
</div>
</div>