From f5488f7b47ed504e66a0413c703b16ba1c8fc8f4 Mon Sep 17 00:00:00 2001 From: Konstantin Lampalzer Date: Sun, 12 Sep 2021 13:46:36 +0200 Subject: [PATCH] Documentation --- docs/source/lib/Display.rst | 23 +++++++++++++++++++++++ docs/source/lib/Encoder.rst | 10 ++++++++++ 2 files changed, 33 insertions(+) create mode 100644 docs/source/lib/Display.rst create mode 100644 docs/source/lib/Encoder.rst diff --git a/docs/source/lib/Display.rst b/docs/source/lib/Display.rst new file mode 100644 index 0000000..6701845 --- /dev/null +++ b/docs/source/lib/Display.rst @@ -0,0 +1,23 @@ +.. _lib_display: + +Display +******* + +Class Documentation +==================== + +.. autoclass:: compLib.Display.Display + :members: + +Examples +========= + +Write a line to the display +--------------------------- + +.. code-block:: python + + import time + from compLib.Display import Display + + Display.write(1, "Hello World!") \ No newline at end of file diff --git a/docs/source/lib/Encoder.rst b/docs/source/lib/Encoder.rst new file mode 100644 index 0000000..1d5bf30 --- /dev/null +++ b/docs/source/lib/Encoder.rst @@ -0,0 +1,10 @@ +.. _lib_encoder: + +Encoder +******* + +Class Documentation +==================== + +.. autoclass:: compLib.Encoder.Encoder + :members: