deploy: 6d8df23

Author: ksiegall

.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: d0482c3bad0df5bc426f6e0996070d04
+tags: 645f666f9bcd5a90fca523b33c5a78b7

.doctrees/api.doctree

@@ -0,0 +1,82 @@
+
+.. If you created a package, create one automodule per module in the package.
+
+.. If your library file(s) are nested in a directory (e.g. /adafruit_foo/foo.py)
+.. use this format as the module name: "adafruit_foo.foo"
+
+API Reference
+=============
+
+.. automodule:: XRPLib
+    :members:
+    :undoc-members:
+
+Hardware
+--------
+
+.. autoclass:: XRPLib.board.Board
+    :members:
+    :undoc-members:
+    
+.. autoclass:: XRPLib.motor.SinglePWMMotor
+    :members:
+    :undoc-members:
+
+.. autoclass:: XRPLib.motor.DualPWMMotor
+    :members:
+    :undoc-members:
+
+.. autoclass:: XRPLib.encoded_motor.EncodedMotor
+    :members:
+    :undoc-members:
+
+.. autoclass:: XRPLib.motor_group.MotorGroup
+    :members:
+    :undoc-members:
+
+.. autoclass:: XRPLib.differential_drive.DifferentialDrive
+    :members:
+    :undoc-members:
+
+.. autoclass:: XRPLib.servo.Servo
+    :members:
+    :undoc-members:
+
+Sensors
+-------
+
+.. autoclass:: XRPLib.encoder.Encoder
+    :members:
+    :undoc-members:
+
+.. autoclass:: XRPLib.imu.IMU
+    :members:
+    :undoc-members:
+
+.. autoclass:: XRPLib.rangefinder.Rangefinder
+    :members:
+    :undoc-members:
+
+.. autoclass:: XRPLib.reflectance.Reflectance
+    :members:
+    :undoc-members:
+
+Miscellaneous
+-------------
+
+.. autoclass:: XRPLib.controller.Controller
+    :members:
+    :undoc-members:
+
+.. autoclass:: XRPLib.pid.PID
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. autoclass:: XRPLib.timeout.Timeout
+    :members:
+    :undoc-members:
+
+.. autoclass:: XRPLib.webserver.Webserver
+    :members:
+    :undoc-members:

.doctrees/defaults.doctree

@@ -0,0 +1,26 @@
+XRPLib.defaults
+---------------
+
+In addition to you being able to construct any of the classes in XRPLib by 
+themselves, you are also able to import all of the default objects needed for
+normal robot operations, using just one line.
+
+By running ``from XRPLib.defaults import *``, you import all of the 
+pre-constructed objects, as specified and named below:
+
+.. literalinclude:: ../XRPLib/defaults.py
+    :caption: ../XRPLib/defaults.py
+    :linenos:
+
+We use this import in most of the curriculum and example programs,
+which is why you will often see the DifferentialDrive class refered to as
+just "drivetrain".
+
+Here's an example of that from ``drive_examples.py``:
+
+>>> from XRPLib.defaults import *
+>>> # Follow the perimeter of a square with variable sidelength
+>>> def square(sidelength):
+>>> for sides in range(4):
+>>>        drivetrain.straight(sidelength, 80)
+>>>        drivetrain.turn(90)``

.doctrees/environment.pickle

@@ -0,0 +1,20 @@
+Example Code
+------------
+
+Feel free to read through, import, and use any of the below sample code:
+
+.. literalinclude:: ../XRPExamples/drive_examples.py
+    :caption: XRPExamples/drive_examples.py
+    :linenos:
+
+.. literalinclude:: ../XRPExamples/sensor_examples.py
+    :caption: XRPExamples/sensor_examples.py
+    :linenos:
+
+.. literalinclude:: ../XRPExamples/led_example.py
+    :caption: XRPExamples/led_example.py
+    :linenos:
+
+.. literalinclude:: ../XRPExamples/webserver_example.py
+    :caption: XRPExamples/webserver_example.py
+    :linenos:

.doctrees/examples.doctree

@@ -0,0 +1,46 @@
+XRPLib - Table of Contents
+==========================
+
+.. image:: _static/xrp-robot.jpg
+    :width: 50%
+
+.. toctree::
+    :maxdepth: 4
+    :hidden:
+
+    self
+
+.. toctree::
+    :caption: Code Documentation
+    :maxdepth: 3
+
+    api
+    defaults
+
+.. toctree::
+    :caption: Examples
+
+    installation_check
+    examples
+
+.. toctree::
+    :caption: Curriculum
+
+    XRP Curriculum <https://introtoroboticsv2.readthedocs.io>
+    XRP User Guide <https://xrpusersguide.readthedocs.io/en/latest/course/introduction.html>
+    XRPLib on GitHub <https://github.com/Open-STEM/XRP_MicroPython/releases/latest>
+    XRP Support Forum <https://xrp.discourse.group>
+
+.. toctree::
+    :caption: Other Links
+
+    Download MicroPython <https://micropython.org/download/>
+    MicroPython Reference Documentation <https://docs.micropython.org/en/latest/>
+    MicroPython Support Forum <https://github.com/orgs/micropython/discussions>
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

.doctrees/index.doctree

@@ -0,0 +1,9 @@
+Installation Verification
+-------------------------
+
+Ensure your device works with this simple test.
+
+.. literalinclude:: ../Examples/installation_verification.py
+    :caption: Examples/installation_verification.py
+    :linenos:
+