Update documentation

_sources/lib/Battery.rst.txt

@@ -1,7 +1,23 @@
 .. _lib_battery:
 
 Battery
-=======
+########
+
+Class Documentation
+********************
 
 .. autoclass:: compLIB.Battery.Battery
-   :members:
+   :members:
+
+
+Examples
+*********
+
+Printing percentage
+====================
+
+.. code-block:: python
+
+    from compLIB.Battery import Battery
+
+    print(Battery.percent())

_sources/lib/Buzzer.rst.txt

@@ -1,7 +1,25 @@
 .. _lib_buzzer:
 
 Buzzer
-=======
+#######
+
+Class Documentation
+********************
 
 .. autoclass:: compLIB.Buzzer.Buzzer
-   :members:
+   :members:
+
+Examples
+*********
+
+Turning buzzer on and off
+==========================
+
+.. code-block:: python
+
+    import time
+    from compLIB.Buzzer import Buzzer
+
+    Buzzer.set(True)
+    time.sleep(1)
+    Buzzer.set(False)

_sources/lib/Motor.rst.txt

@@ -1,7 +1,23 @@
 .. _lib_motor:
 
 Motor
-=====
+######
+
+Class Documentation
+********************
 
 .. autoclass:: compLIB.Motor.Motor
-   :members:
+   :members:
+
+Examples
+*********
+
+Driving straight (maybe)
+=========================
+
+.. code-block:: python
+
+    from compLIB.Motor import Motor
+
+    for port in range(0, 4):
+        Motor.power(port, 50)

index.html

@@ -169,10 +169,31 @@
 <div class="toctree-wrapper compound">
 <ul class="current">
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Welcome to CompLib’s documentation!</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/Battery.html">Battery</a><ul>
-<li class="toctree-l1"><a class="reference internal" href="lib/Buzzer.html">Buzzer</a></li>
+<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>
+<li class="toctree-l3"><a class="reference internal" href="lib/Battery.html#printing-percentage">Printing percentage</a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="lib/Buzzer.html">Buzzer</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="lib/Buzzer.html#class-documentation">Class Documentation</a></li>
+<li class="toctree-l2"><a class="reference internal" href="lib/Buzzer.html#examples">Examples</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="lib/Buzzer.html#turning-buzzer-on-and-off">Turning buzzer on and off</a></li>
+</ul>
+</li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="lib/IRSensor.html">Infrared Sensor</a></li>
-<li class="toctree-l1"><a class="reference internal" href="lib/Motor.html">Motor</a></li>
+<li class="toctree-l1"><a class="reference internal" href="lib/Motor.html">Motor</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="lib/Motor.html#class-documentation">Class Documentation</a></li>
+<li class="toctree-l2"><a class="reference internal" href="lib/Motor.html#examples">Examples</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="lib/Motor.html#driving-straight-maybe">Driving straight (maybe)</a></li>
+</ul>
+</li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="lib/Servo.html">Servo</a></li>
 </ul>
 </div>

lib/Battery.html

@@ -83,7 +83,14 @@
             
               <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="../index.html">Welcome to CompLib’s 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>
 
 

lib/Buzzer.html

@@ -84,7 +84,14 @@
               <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="../index.html">Welcome to CompLib’s documentation!</a></li>
 <li class="toctree-l1"><a class="reference internal" href="Battery.html">Battery</a></li>
-<li class="toctree-l1 current"><a class="current reference internal" href="#">Buzzer</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">Buzzer</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="#turning-buzzer-on-and-off">Turning buzzer on and off</a></li>
+</ul>
+</li>
+</ul>
+</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>
 <li class="toctree-l1"><a class="reference internal" href="Servo.html">Servo</a></li>
@@ -155,6 +162,8 @@
             
   <div class="section" id="buzzer">
 <span id="lib-buzzer"></span><h1>Buzzer<a class="headerlink" href="#buzzer" 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.Buzzer.Buzzer">
 <em class="property">class </em><code class="sig-prename descclassname">compLIB.Buzzer.</code><code class="sig-name descname">Buzzer</code><a class="headerlink" href="#compLIB.Buzzer.Buzzer" title="Permalink to this definition">¶</a></dt>
@@ -172,6 +181,21 @@
 
 </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="turning-buzzer-on-and-off">
+<h3>Turning buzzer on and off<a class="headerlink" href="#turning-buzzer-on-and-off" title="Permalink to this headline">¶</a></h3>
+<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">time</span>
+<span class="kn">from</span> <span class="nn">compLIB.Buzzer</span> <span class="kn">import</span> <span class="n">Buzzer</span>
+
+<span class="n">Buzzer</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="kc">True</span><span class="p">)</span>
+<span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
+<span class="n">Buzzer</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="kc">False</span><span class="p">)</span>
+</pre></div>
+</div>
+</div>
+</div>
 </div>
 
 

lib/Motor.html

@@ -86,7 +86,14 @@
 <li class="toctree-l1"><a class="reference internal" href="Battery.html">Battery</a></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 current"><a class="current reference internal" href="#">Motor</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">Motor</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="#driving-straight-maybe">Driving straight (maybe)</a></li>
+</ul>
+</li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="Servo.html">Servo</a></li>
 </ul>
 
@@ -155,6 +162,8 @@
             
   <div class="section" id="motor">
 <span id="lib-motor"></span><h1>Motor<a class="headerlink" href="#motor" 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.Motor.Motor">
 <em class="property">class </em><code class="sig-prename descclassname">compLIB.Motor.</code><code class="sig-name descname">Motor</code><a class="headerlink" href="#compLIB.Motor.Motor" title="Permalink to this definition">¶</a></dt>
@@ -181,6 +190,19 @@
 
 </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="driving-straight-maybe">
+<h3>Driving straight (maybe)<a class="headerlink" href="#driving-straight-maybe" 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.Motor</span> <span class="kn">import</span> <span class="n">Motor</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">50</span><span class="p">)</span>
+</pre></div>
+</div>
+</div>
+</div>
 </div>
 
 

searchindex.js

@@ -1 +1 @@
-Search.setIndex({docnames:["index","lib/Battery","lib/Buzzer","lib/IRSensor","lib/Motor","lib/Servo"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,sphinx:56},filenames:["index.rst","lib/Battery.rst","lib/Buzzer.rst","lib/IRSensor.rst","lib/Motor.rst","lib/Servo.rst"],objects:{"compLIB.Battery":{Battery:[1,0,1,""]},"compLIB.Battery.Battery":{percent:[1,1,1,""]},"compLIB.Buzzer":{Buzzer:[2,0,1,""]},"compLIB.Buzzer.Buzzer":{set:[2,1,1,""]},"compLIB.IRSensor":{IRSensor:[3,0,1,""]},"compLIB.IRSensor.IRSensor":{bottom_left:[3,1,1,""],bottom_middle:[3,1,1,""],bottom_right:[3,1,1,""],top_left_percent:[3,1,1,""],top_right_percent:[3,1,1,""]},"compLIB.Motor":{Motor:[4,0,1,""]},"compLIB.Motor.Motor":{all_off:[4,1,1,""],power:[4,1,1,""]},"compLIB.Servo":{Servo:[5,0,1,""]},"compLIB.Servo.Servo":{set_position:[5,1,1,""],setup_position:[5,1,1,""]}},objnames:{"0":["py","class","Python class"],"1":["py","method","Python method"]},objtypes:{"0":"py:class","1":"py:method"},terms:{"100":[1,3,4],"class":[1,2,3,4,5],"int":[1,3,4,5],"return":[1,3],"static":[1,2,3,4,5],"true":[2,3],Used:[1,2],access:3,all:4,all_off:4,angl:5,batteri:0,between:[1,3,4,5],bool:[2,3],bottom:3,bottom_left:3,bottom_middl:3,bottom_right:3,buzzer:0,channel:5,complib:[1,2,3,4,5],connect:[4,5],control:[4,5],detect:3,differ:3,dure:5,fals:2,get:[1,3],index:0,infrar:0,interact:[1,2],irsensor:3,left:[3,4],max:4,middl:3,modul:0,motor:0,off:2,page:0,paramet:[2,4,5],percent:[1,4],percentag:[1,3,4],port:[4,5],posit:5,power:4,process:5,right:[3,4],robot:[3,5],search:0,sensor:0,servo:0,set:[2,4,5],set_posit:5,setup:5,setup_posit:5,signal:3,specifi:4,speed:4,statu:3,top:[3,4],top_left_perc:3,top_right_perc:3,turn:[2,4],type:[1,3],used:[4,5],which:4},titles:["Welcome to CompLib\u2019s documentation!","Battery","Buzzer","Infrared Sensor","Motor","Servo"],titleterms:{batteri:1,buzzer:2,complib:0,content:0,document:0,indic:0,infrar:3,motor:4,sensor:3,servo:5,tabl:0,welcom:0}})
+Search.setIndex({docnames:["index","lib/Battery","lib/Buzzer","lib/IRSensor","lib/Motor","lib/Servo"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,sphinx:56},filenames:["index.rst","lib/Battery.rst","lib/Buzzer.rst","lib/IRSensor.rst","lib/Motor.rst","lib/Servo.rst"],objects:{"compLIB.Battery":{Battery:[1,0,1,""]},"compLIB.Battery.Battery":{percent:[1,1,1,""]},"compLIB.Buzzer":{Buzzer:[2,0,1,""]},"compLIB.Buzzer.Buzzer":{set:[2,1,1,""]},"compLIB.IRSensor":{IRSensor:[3,0,1,""]},"compLIB.IRSensor.IRSensor":{bottom_left:[3,1,1,""],bottom_middle:[3,1,1,""],bottom_right:[3,1,1,""],top_left_percent:[3,1,1,""],top_right_percent:[3,1,1,""]},"compLIB.Motor":{Motor:[4,0,1,""]},"compLIB.Motor.Motor":{all_off:[4,1,1,""],power:[4,1,1,""]},"compLIB.Servo":{Servo:[5,0,1,""]},"compLIB.Servo.Servo":{set_position:[5,1,1,""],setup_position:[5,1,1,""]}},objnames:{"0":["py","class","Python class"],"1":["py","method","Python method"]},objtypes:{"0":"py:class","1":"py:method"},terms:{"100":[1,3,4],"class":[0,3,5],"import":[1,2,4],"int":[1,3,4,5],"return":[1,3],"static":[1,2,3,4,5],"true":[2,3],Used:[1,2],access:3,all:4,all_off:4,angl:5,batteri:0,between:[1,3,4,5],bool:[2,3],bottom:3,bottom_left:3,bottom_middl:3,bottom_right:3,buzzer:0,channel:5,complib:[1,2,3,4,5],connect:[4,5],control:[4,5],detect:3,differ:3,drive:0,dure:5,exampl:0,fals:2,from:[1,2,4],get:[1,3],index:0,infrar:0,interact:[1,2],irsensor:3,left:[3,4],max:4,mayb:0,middl:3,modul:0,motor:0,off:0,page:0,paramet:[2,4,5],percent:[1,4],percentag:[0,3,4],port:[4,5],posit:5,power:4,print:0,process:5,rang:4,right:[3,4],robot:[3,5],search:0,sensor:0,servo:0,set:[2,4,5],set_posit:5,setup:5,setup_posit:5,signal:3,sleep:2,specifi:4,speed:4,statu:3,straight:0,time:2,top:[3,4],top_left_perc:3,top_right_perc:3,turn:[0,4],type:[1,3],used:[4,5],which:4},titles:["Welcome to CompLib\u2019s documentation!","Battery","Buzzer","Infrared Sensor","Motor","Servo"],titleterms:{"class":[1,2,4],batteri:1,buzzer:2,complib:0,content:0,document:[0,1,2,4],drive:4,exampl:[1,2,4],indic:0,infrar:3,mayb:4,motor:4,off:2,percentag:1,print:1,sensor:3,servo:5,straight:4,tabl:0,turn:2,welcom:0}})