update docs to new mkdocstrings python handler

janickr · Feb 23, 2024 · 6caec24 · 6caec24
1 parent aeb86ff
commit 6caec24
Show file tree

Hide file tree

Showing 15 changed files with 106 additions and 99 deletions.
diff --git a/docs/requirements.txt b/docs/requirements.txt
diff --git a/docs/test-all-services.md b/docs/test-all-services.md
@@ -6,6 +6,7 @@ description: Diagnostic program that prints out which services are enabled on a
 This example tests which services are available on a micro:bit
 
 The API documentation: 
+
 - [kaspersmicrobit](reference/kaspersmicrobit.md)
 
 Example:

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -100,6 +100,13 @@ plugins:
                 - sys.modules["bleak"] = mock()
               options:
                   docstring_style: "google"
+                  members_order: "source"
+                  show_symbol_type_toc: true
+                  docstring_section_style: list
+                  separate_signature: true
+                  line_length: 60
+                  show_signature_annotations: True
+
 watch:
   - src/kaspersmicrobit
 

diff --git a/src/kaspersmicrobit/kaspersmicrobit.py b/src/kaspersmicrobit/kaspersmicrobit.py
@@ -155,8 +155,7 @@ def find_microbits(timeout: int = 3, loop: BluetoothEventLoop = None) -> List['K
                   uitvoert.
 
         Returns:
-            List[KaspersMicrobit]: Een lijst van gevonden micro:bits, deze kan ook leeg zijn,
-                  als er geen micro:bits gevonden werden
+            Een lijst van gevonden micro:bits, deze kan ook leeg zijn, als er geen micro:bits gevonden werden
 
         """
 

diff --git a/src/kaspersmicrobit/services/accelerometer.py b/src/kaspersmicrobit/services/accelerometer.py
@@ -122,8 +122,8 @@ def notify(self, callback: Callable[[AccelerometerData], None]):
                 zijn van de accelerometer. De nieuwe AccelerometerData worden meegegeven als argument aan deze functie
 
         Raises:
-            BluetoothServiceNotFound: Wanneer de accelerometer service niet actief is op de micro:bit
-            BluetoothCharacteristicNotFound: Wanneer de accelerometer service actief is, maar er geen manier was om de
+            errors.BluetoothServiceNotFound: Wanneer de accelerometer service niet actief is op de micro:bit
+            errors.BluetoothCharacteristicNotFound: Wanneer de accelerometer service actief is, maar er geen manier was om de
                 accelerometer data notificaties te activeren (komt normaal gezien niet voor)
         """
         self._device.notify(Service.ACCELEROMETER, Characteristic.ACCELEROMETER_DATA,
@@ -137,8 +137,8 @@ def read(self) -> AccelerometerData:
             De gegevens van de accelerometer (x, y en z)
 
         Raises:
-            BluetoothServiceNotFound: Wanneer de accelerometer service niet actief is op de micro:bit
-            BluetoothCharacteristicNotFound: Wanneer de accelerometer service actief is, maar er geen manier was om de
+            errors.BluetoothServiceNotFound: Wanneer de accelerometer service niet actief is op de micro:bit
+            errors.BluetoothCharacteristicNotFound: Wanneer de accelerometer service actief is, maar er geen manier was om de
                 accelerometer data te lezen (komt normaal gezien niet voor)
         """
         return AccelerometerData.from_bytes(self._device.read(Service.ACCELEROMETER, Characteristic.ACCELEROMETER_DATA))
@@ -152,8 +152,8 @@ def set_period(self, period: AccelerometerPeriod):
                 geldige waarden zijn: 1, 2, 5, 10, 20, 80, 160, 640
 
         Raises:
-            BluetoothServiceNotFound: Wanneer de accelerometer service niet actief is op de micro:bit
-            BluetoothCharacteristicNotFound: Wanneer de accelerometer service actief is, maar er geen manier was om de
+            errors.BluetoothServiceNotFound: Wanneer de accelerometer service niet actief is op de micro:bit
+            errors.BluetoothCharacteristicNotFound: Wanneer de accelerometer service actief is, maar er geen manier was om de
                 accelerometer periode te wijzigen (komt normaal gezien niet voor)
 
         Warning:
@@ -170,8 +170,8 @@ def read_period(self) -> int:
             Het interval in milliseconden
 
         Raises:
-            BluetoothServiceNotFound: Wanneer de accelerometer service niet actief is op de micro:bit
-            BluetoothCharacteristicNotFound: Wanneer de accelerometer service actief is, maar er geen manier was om de
+            errors.BluetoothServiceNotFound: Wanneer de accelerometer service niet actief is op de micro:bit
+            errors.BluetoothCharacteristicNotFound: Wanneer de accelerometer service actief is, maar er geen manier was om de
                 accelerometer periode te lezen (komt normaal gezien niet voor)
         """
         return int.from_bytes(self._device.read(Service.ACCELEROMETER, Characteristic.ACCELEROMETER_PERIOD)[0:2], "little")
diff --git a/src/kaspersmicrobit/services/buttons.py b/src/kaspersmicrobit/services/buttons.py
@@ -76,8 +76,8 @@ def on_button_a(self, press: ButtonCallback = None, long_press: ButtonCallback =
             release (ButtonCallback): een functie die wordt opgeroepen wanneer de A knop wordt losgelaten
 
         Raises:
-            BluetoothServiceNotFound: Wanneer de button service niet actief is op de micro:bit
-            BluetoothCharacteristicNotFound: Wanneer de button service actief is, maar er geen manier was om de
+            errors.BluetoothServiceNotFound: Wanneer de button service niet actief is op de micro:bit
+            errors.BluetoothCharacteristicNotFound: Wanneer de button service actief is, maar er geen manier was om de
                 notificaties voor button A te activeren (komt normaal gezien niet voor)
         """
         self._device.notify(Service.BUTTON, Characteristic.BUTTON_A,
@@ -99,8 +99,8 @@ def on_button_b(self, press: ButtonCallback = None, long_press: ButtonCallback =
             release (ButtonCallback): een functie die wordt opgeroepen wanneer de B knop wordt losgelaten
 
         Raises:
-            BluetoothServiceNotFound: Wanneer de button service niet actief is op de micro:bit
-            BluetoothCharacteristicNotFound: Wanneer de button service actief is, maar er geen manier was om de
+            errors.BluetoothServiceNotFound: Wanneer de button service niet actief is op de micro:bit
+            errors.BluetoothCharacteristicNotFound: Wanneer de button service actief is, maar er geen manier was om de
                 notificaties voor button B te activeren (komt normaal gezien niet voor)
         """
         self._device.notify(Service.BUTTON, Characteristic.BUTTON_B,
@@ -114,8 +114,8 @@ def read_button_a(self) -> ButtonState:
             De toestand van de A knop (RELEASE, PRESS of LONG_PRESS)
 
         Raises:
-            BluetoothServiceNotFound: Wanneer de button service niet actief is op de micro:bit
-            BluetoothCharacteristicNotFound: Wanneer de button service actief is, maar er geen manier was om
+            errors.BluetoothServiceNotFound: Wanneer de button service niet actief is op de micro:bit
+            errors.BluetoothCharacteristicNotFound: Wanneer de button service actief is, maar er geen manier was om
                 de staat van button A te lezen (komt normaal gezien niet voor)
         """
         return ButtonState(self._device.read(Service.BUTTON, Characteristic.BUTTON_A)[0])
@@ -128,8 +128,8 @@ def read_button_b(self) -> ButtonState:
             De toestand van de B knop (RELEASE, PRESS of LONG_PRESS)
 
         Raises:
-            BluetoothServiceNotFound: Wanneer de button service niet actief is op de micro:bit
-            BluetoothCharacteristicNotFound: Wanneer de button service actief is, maar er geen manier was om
+            errors.BluetoothServiceNotFound: Wanneer de button service niet actief is op de micro:bit
+            errors.BluetoothCharacteristicNotFound: Wanneer de button service actief is, maar er geen manier was om
                 de staat van button B te lezen (komt normaal gezien niet voor)
         """
         return ButtonState(self._device.read(Service.BUTTON, Characteristic.BUTTON_B)[0])
diff --git a/src/kaspersmicrobit/services/device_information.py b/src/kaspersmicrobit/services/device_information.py
@@ -28,8 +28,8 @@ def read_model_number(self) -> str:
             het modelnummer van de micro:bit
 
         Raises:
-            BluetoothServiceNotFound: Wanneer de device information service niet actief is op de micro:bit
-            BluetoothCharacteristicNotFound: Wanneer de button device information actief is, maar er geen manier was
+            errors.BluetoothServiceNotFound: Wanneer de device information service niet actief is op de micro:bit
+            errors.BluetoothCharacteristicNotFound: Wanneer de button device information actief is, maar er geen manier was
                 om het modelnummer te lezen (komt normaal gezien niet voor)
         """
         return str(self._device.read(Service.DEVICE_INFORMATION, Characteristic.MODEL_NUMBER_STRING), "utf-8")
@@ -42,8 +42,8 @@ def read_serial_number(self) -> str:
             het serienummer van de micro:bit
 
         Raises:
-            BluetoothServiceNotFound: Wanneer de device information service niet actief is op de micro:bit
-            BluetoothCharacteristicNotFound: Wanneer de button device information actief is, maar er geen manier was
+            errors.BluetoothServiceNotFound: Wanneer de device information service niet actief is op de micro:bit
+            errors.BluetoothCharacteristicNotFound: Wanneer de button device information actief is, maar er geen manier was
                 om het serienummer te lezen (komt normaal gezien niet voor)
         """
         return str(self._device.read(Service.DEVICE_INFORMATION, Characteristic.SERIAL_NUMBER_STRING), "utf-8")
@@ -56,8 +56,8 @@ def read_firmware_revision(self) -> str:
             de firmware versie string van de micro:bit
 
         Raises:
-            BluetoothServiceNotFound: Wanneer de device information service niet actief is op de micro:bit
-            BluetoothCharacteristicNotFound: Wanneer de button device information actief is, maar er geen manier was
+            errors.BluetoothServiceNotFound: Wanneer de device information service niet actief is op de micro:bit
+            errors.BluetoothCharacteristicNotFound: Wanneer de button device information actief is, maar er geen manier was
                 om de firmware versie te lezen (komt normaal gezien niet voor)
         """
         return str(self._device.read(Service.DEVICE_INFORMATION, Characteristic.FIRMWARE_REVISION_STRING), "utf-8")
@@ -74,8 +74,8 @@ def read_hardware_revision(self) -> str:
             de hardware versie string van de micro:bit
 
         Raises:
-            BluetoothServiceNotFound: Wanneer de device information service niet actief is op de micro:bit
-            BluetoothCharacteristicNotFound: Wanneer de button device information actief is, maar er geen manier was
+            errors.BluetoothServiceNotFound: Wanneer de device information service niet actief is op de micro:bit
+            errors.BluetoothCharacteristicNotFound: Wanneer de button device information actief is, maar er geen manier was
                 om de hardware versie te lezen (komt normaal gezien niet voor)
         """
         return str(self._device.read(Service.DEVICE_INFORMATION, Characteristic.HARDWARE_REVISION_STRING), "utf-8")
@@ -92,8 +92,8 @@ def read_manufacturer_name(self) -> str:
             de naam van de fabrikant van de micro:bit
 
         Raises:
-            BluetoothServiceNotFound: Wanneer de device information service niet actief is op de micro:bit
-            BluetoothCharacteristicNotFound: Wanneer de button device information actief is, maar er geen manier was
+            errors.BluetoothServiceNotFound: Wanneer de device information service niet actief is op de micro:bit
+            errors.BluetoothCharacteristicNotFound: Wanneer de button device information actief is, maar er geen manier was
                 om de naam van de fabrikant te lezen (komt normaal gezien niet voor)
         """
         return str(self._device.read(Service.DEVICE_INFORMATION, Characteristic.MANUFACTURER_NAME_STRING), "utf-8")
diff --git a/src/kaspersmicrobit/services/events.py b/src/kaspersmicrobit/services/events.py
@@ -56,8 +56,8 @@ def notify_microbit_requirements(self, callback: Callable[[Event], None]):
             callback: een functie die wordt opgeroepen met een Event
 
         Raises:
-            BluetoothServiceNotFound: Wanneer de events service niet actief is op de micro:bit
-            BluetoothCharacteristicNotFound: Wanneer de events service actief is, maar er geen manier was
+            errors.BluetoothServiceNotFound: Wanneer de events service niet actief is op de micro:bit
+            errors.BluetoothCharacteristicNotFound: Wanneer de events service actief is, maar er geen manier was
                 om de notificaties voor de microbit requirements te activeren (komt normaal gezien niet voor)
         """
         self._device.notify(Characteristic.MICROBIT_REQUIREMENTS,
@@ -75,8 +75,8 @@ def read_microbit_requirements(self) -> List[Event]:
             List[Event]: Een lijst van events waarvan je de micro:bit moet verwittigen wanneer ze zich voordoen
 
         Raises:
-            BluetoothServiceNotFound: Wanneer de events service niet actief is op de micro:bit
-            BluetoothCharacteristicNotFound: Wanneer de events service actief is, maar er geen manier was
+            errors.BluetoothServiceNotFound: Wanneer de events service niet actief is op de micro:bit
+            errors.BluetoothCharacteristicNotFound: Wanneer de events service actief is, maar er geen manier was
                 om de microbit requirements te lezen (komt normaal gezien niet voor)
         """
         return Event.list_from_bytes(self._device.read(Service.EVENT, Characteristic.MICROBIT_REQUIREMENTS))
@@ -91,8 +91,8 @@ def notify_microbit_event(self, callback: Callable[[Event], None]):
             callback: een functie die wordt opgeroepen met een Event
 
         Raises:
-            BluetoothServiceNotFound: Wanneer de events service niet actief is op de micro:bit
-            BluetoothCharacteristicNotFound: Wanneer de events service actief is, maar er geen manier was
+            errors.BluetoothServiceNotFound: Wanneer de events service niet actief is op de micro:bit
+            errors.BluetoothCharacteristicNotFound: Wanneer de events service actief is, maar er geen manier was
                 om de notificaties voor de microbit events te activeren (komt normaal gezien niet voor)
         """
         self._device.notify(Service.EVENT, Characteristic.MICROBIT_EVENT,
@@ -108,8 +108,8 @@ def read_microbit_event(self) -> List[Event]:
             List[Event]: Een lijst van events die zich hebben voorgedaan op de micro:bit
 
         Raises:
-            BluetoothServiceNotFound: Wanneer de events service niet actief is op de micro:bit
-            BluetoothCharacteristicNotFound: Wanneer de events service actief is, maar er geen manier was
+            errors.BluetoothServiceNotFound: Wanneer de events service niet actief is op de micro:bit
+            errors.BluetoothCharacteristicNotFound: Wanneer de events service actief is, maar er geen manier was
                 om de microbit events te lezen (komt normaal gezien niet voor)
         """
         return Event.list_from_bytes(self._device.read(Service.EVENT, Characteristic.MICROBIT_EVENT))
@@ -126,8 +126,8 @@ def write_client_requirements(self, *events: Event):
             *events (Event): de events die je wil ontvangen van de micro:bit
 
         Raises:
-            BluetoothServiceNotFound: Wanneer de events service niet actief is op de micro:bit
-            BluetoothCharacteristicNotFound: Wanneer de events service actief is, maar er geen manier was
+            errors.BluetoothServiceNotFound: Wanneer de events service niet actief is op de micro:bit
+            errors.BluetoothCharacteristicNotFound: Wanneer de events service actief is, maar er geen manier was
                 om de client requirements te schrijven (komt normaal gezien niet voor)
         """
         for event in events:
@@ -143,8 +143,8 @@ def write_client_event(self, *events: Event):
            *events (Event): de events die je wil verzenden naar de micro:bit
 
         Raises:
-            BluetoothServiceNotFound: Wanneer de events service niet actief is op de micro:bit
-            BluetoothCharacteristicNotFound: Wanneer de events service actief is, maar er geen manier was
+            errors.BluetoothServiceNotFound: Wanneer de events service niet actief is op de micro:bit
+            errors.BluetoothCharacteristicNotFound: Wanneer de events service actief is, maar er geen manier was
                 om de client events te schrijven (komt normaal gezien niet voor)
         """
         for event in events:

diff --git a/src/kaspersmicrobit/services/generic_access.py b/src/kaspersmicrobit/services/generic_access.py
@@ -33,8 +33,8 @@ def read_device_name(self) -> str:
             de naam van de micro:bit
 
         Raises:
-            BluetoothServiceNotFound: Wanneer de generic access service niet actief is op de micro:bit
-            BluetoothCharacteristicNotFound: Wanneer de generic acces service actief is, maar er geen manier was
+            errors.BluetoothServiceNotFound: Wanneer de generic access service niet actief is op de micro:bit
+            errors.BluetoothCharacteristicNotFound: Wanneer de generic acces service actief is, maar er geen manier was
                 om de device naam te lezen (komt normaal gezien niet voor)
         """
         return str(self._device.read(Service.GENERIC_ACCESS, Characteristic.DEVICE_NAME), "utf-8")