From ec0b5562cf619111da5b7b2ff7dce1916b45dca9 Mon Sep 17 00:00:00 2001 From: Konstantin Lampalzer Date: Sat, 16 Jan 2021 01:55:22 +0100 Subject: [PATCH] Add code examples --- docs/source/lib/Battery.rst | 20 ++++++++++++++++++-- docs/source/lib/Buzzer.rst | 22 ++++++++++++++++++++-- docs/source/lib/Motor.rst | 20 ++++++++++++++++++-- 3 files changed, 56 insertions(+), 6 deletions(-) diff --git a/docs/source/lib/Battery.rst b/docs/source/lib/Battery.rst index c9505fb..306730e 100644 --- a/docs/source/lib/Battery.rst +++ b/docs/source/lib/Battery.rst @@ -1,7 +1,23 @@ .. _lib_battery: Battery -======= +######## + +Class Documentation +******************** .. autoclass:: compLIB.Battery.Battery - :members: \ No newline at end of file + :members: + + +Examples +********* + +Printing percentage +==================== + +.. code-block:: python + + from compLIB.Battery import Battery + + print(Battery.percent()) \ No newline at end of file diff --git a/docs/source/lib/Buzzer.rst b/docs/source/lib/Buzzer.rst index 8a1894a..e5f7790 100644 --- a/docs/source/lib/Buzzer.rst +++ b/docs/source/lib/Buzzer.rst @@ -1,7 +1,25 @@ .. _lib_buzzer: Buzzer -======= +####### + +Class Documentation +******************** .. autoclass:: compLIB.Buzzer.Buzzer - :members: \ No newline at end of file + :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) \ No newline at end of file diff --git a/docs/source/lib/Motor.rst b/docs/source/lib/Motor.rst index 2d26d06..f5b9d09 100644 --- a/docs/source/lib/Motor.rst +++ b/docs/source/lib/Motor.rst @@ -1,7 +1,23 @@ .. _lib_motor: Motor -===== +###### + +Class Documentation +******************** .. autoclass:: compLIB.Motor.Motor - :members: \ No newline at end of file + :members: + +Examples +********* + +Driving straight (maybe) +========================= + +.. code-block:: python + + from compLIB.Motor import Motor + + for port in range(0, 4): + Motor.power(port, 50) \ No newline at end of file