Added docstrings

nisseknudsen · nisseknudsen · commit a452c5f4b216 · 2025-08-01T09:20:01.000-07:00
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -1,8 +1,16 @@
 site_name: Python3 SDK | make87
 docs_dir: src
 nav:
-  - Home: index.md
-  - API Reference: reference/
+  - API Reference:
+    - make87: reference/index.md
+    - config: reference/config.md
+    - encodings: reference/encodings/index.md
+    - host: reference/host.md
+    - interfaces: reference/interfaces/index.md
+    - models: reference/models/index.md
+    - peripherals: reference/peripherals/index.md
+    - storage: reference/storage.md
+
 plugins:
   - search:
       lang:
diff --git a/make87/__init__.py b/make87/__init__.py
@@ -54,6 +54,7 @@ def run_forever() -> None:
         calling this function.
 
     Example:
+
         >>> import make87
         >>> # Set up your application components here
         >>> make87.run_forever()  # Blocks until signal received
diff --git a/make87/config.py b/make87/config.py
@@ -66,6 +66,7 @@ def load_config_from_env(var: str = CONFIG_ENV_VAR) -> ApplicationConfig:
         RuntimeError: If the environment variable is missing or contains invalid JSON.
 
     Example:
+
         >>> import os
         >>> os.environ["MAKE87_CONFIG"] = '{"application_info": {...}, "config": {...}}'
         >>> config = load_config_from_env()
@@ -95,6 +96,7 @@ def load_config_from_json(json_data: Union[str, Dict]) -> ApplicationConfig:
         TypeError: If json_data is neither a string nor a dictionary.
 
     Example:
+
         >>> config_dict = {"application_info": {...}, "config": {...}}
         >>> config = load_config_from_json(config_dict)
         >>> config_json = '{"application_info": {...}, "config": {...}}'
@@ -141,6 +143,7 @@ def get_config_value(
         KeyError: If the configuration key is not found and no default is provided.
 
     Example:
+
         >>> config = load_config_from_env()
         >>> port = get_config_value(config, "port", default=8080, converter=int)
         >>> debug = get_config_value(config, "debug", default=False, converter=bool)
diff --git a/make87/encodings/json_.py b/make87/encodings/json_.py
@@ -39,6 +39,7 @@ def __init__(
                 a JSON-serializable object or raise TypeError.
 
         Example:
+
             >>> # Simple encoder
             >>> encoder = JsonEncoder()
             >>>
@@ -70,6 +71,7 @@ def encode(self, obj: T) -> bytes:
                 or other serialization errors
 
         Example:
+
             >>> encoder = JsonEncoder()
             >>> data = {"key": "value", "number": 42}
             >>> encoded = encoder.encode(data)
@@ -95,6 +97,7 @@ def decode(self, data: bytes) -> T:
                 or encoding issues
 
         Example:
+
             >>> encoder = JsonEncoder()
             >>> data = b'{"key": "value", "number": 42}'
             >>> decoded = encoder.decode(data)
diff --git a/make87/encodings/protobuf/pb4.py b/make87/encodings/protobuf/pb4.py
@@ -34,6 +34,7 @@ def __init__(self, message_type: Type[T]) -> None:
                 This must be a subclass of google.protobuf.message.Message.
 
         Example:
+
             >>> from my_protos import MyMessage
             >>> encoder = ProtobufEncoder(MyMessage)
             >>>
@@ -57,6 +58,7 @@ def encode(self, obj: T) -> bytes:
             TypeError: If the object is not an instance of the configured message type
 
         Example:
+
             >>> encoder = ProtobufEncoder(MyMessage)
             >>> message = MyMessage()
             >>> message.name = "example"
@@ -78,6 +80,7 @@ def decode(self, data: bytes) -> T:
                 as a valid protobuf message of the configured type
 
         Example:
+
             >>> encoder = ProtobufEncoder(MyMessage)
             >>> data = b'\\x08\\x96\\x01'  # Some protobuf-encoded bytes
             >>> message = encoder.decode(data)
diff --git a/make87/encodings/protobuf/pb5.py b/make87/encodings/protobuf/pb5.py
@@ -34,6 +34,7 @@ def __init__(self, message_type: Type[T]) -> None:
                 This must be a subclass of google.protobuf.message.Message.
 
         Example:
+
             >>> from my_protos import MyMessage
             >>> encoder = ProtobufEncoder(MyMessage)
             >>>
@@ -57,6 +58,7 @@ def encode(self, obj: T) -> bytes:
             TypeError: If the object is not an instance of the configured message type
 
         Example:
+
             >>> encoder = ProtobufEncoder(MyMessage)
             >>> message = MyMessage()
             >>> message.name = "example"
@@ -78,6 +80,7 @@ def decode(self, data: bytes) -> T:
                 as a valid protobuf message of the configured type
 
         Example:
+
             >>> encoder = ProtobufEncoder(MyMessage)
             >>> data = b'\\x08\\x96\\x01'  # Some protobuf-encoded bytes
             >>> message = encoder.decode(data)
diff --git a/make87/encodings/protobuf/pb6.py b/make87/encodings/protobuf/pb6.py
@@ -34,6 +34,7 @@ def __init__(self, message_type: Type[T]) -> None:
                 This must be a subclass of google.protobuf.message.Message.
 
         Example:
+
             >>> from my_protos import MyMessage
             >>> encoder = ProtobufEncoder(MyMessage)
             >>>
@@ -57,6 +58,7 @@ def encode(self, obj: T) -> bytes:
             TypeError: If the object is not an instance of the configured message type
 
         Example:
+
             >>> encoder = ProtobufEncoder(MyMessage)
             >>> message = MyMessage()
             >>> message.name = "example"
@@ -78,6 +80,7 @@ def decode(self, data: bytes) -> T:
                 as a valid protobuf message of the configured type
 
         Example:
+
             >>> encoder = ProtobufEncoder(MyMessage)
             >>> data = b'\\x08\\x96\\x01'  # Some protobuf-encoded bytes
             >>> message = encoder.decode(data)
diff --git a/make87/encodings/yaml_.py b/make87/encodings/yaml_.py
@@ -35,6 +35,7 @@ def __init__(self, *, loader: Optional[type] = None, dumper: Optional[type] = No
                     Defaults to yaml.SafeDumper for security.
 
             Example:
+
                 >>> # Simple encoder with safe defaults
                 >>> encoder = YamlEncoder()
                 >>>
@@ -61,6 +62,7 @@ def encode(self, obj: T) -> bytes:
                     or other serialization errors
 
             Example:
+
                 >>> encoder = YamlEncoder()
                 >>> data = {"key": "value", "items": [1, 2, 3]}
                 >>> encoded = encoder.encode(data)
@@ -90,6 +92,7 @@ def decode(self, data: bytes) -> T:
                     or encoding issues
 
             Example:
+
                 >>> encoder = YamlEncoder()
                 >>> yaml_data = b'key: value\\nitems:\\n- 1\\n- 2\\n- 3\\n'
                 >>> decoded = encoder.decode(yaml_data)
diff --git a/make87/host.py b/make87/host.py
@@ -23,6 +23,7 @@ def host_is_updating() -> bool:
         If the file exists, it indicates that an update is in progress.
 
     Example:
+
         >>> import make87.host
         >>> if make87.host.host_is_updating():
         ...     print("Host is updating, waiting...")
diff --git a/make87/interfaces/base.py b/make87/interfaces/base.py
@@ -99,6 +99,7 @@ def get_interface_type_by_name(
             NotImplementedError: If the interface type is not supported
 
         Example:
+
             >>> interface = SomeInterface("my_interface")
             >>> pub_config = interface.get_interface_type_by_name("output", "PUB")
             >>> sub_config = interface.get_interface_type_by_name("input", "SUB")
diff --git a/make87/interfaces/rerun/__init__.py b/make87/interfaces/rerun/__init__.py
@@ -32,6 +32,7 @@ def init_and_connect_grpc(interface_name: str, client_name: str, make87_config:
         ImportError: If rerun package is not installed
 
     Example:
+
         >>> import make87.interfaces.rerun as rerun_interface
         >>> rerun_interface.init_and_connect_grpc("rerun", "rerun-grpc-client")
         >>> # Now you can use rerun.log() functions
diff --git a/make87/interfaces/zenoh/interface.py b/make87/interfaces/zenoh/interface.py
@@ -91,6 +91,7 @@ def get_publisher(self, name: str) -> zenoh.Publisher:
             QoS settings from the interface configuration.
 
         Example:
+
             >>> interface = ZenohInterface("my_interface")
             >>> publisher = interface.get_publisher("output_topic")
             >>> publisher.put("Hello, World!")
@@ -128,6 +129,7 @@ def get_subscriber(
             and channel settings.
 
         Example:
+
             >>> interface = ZenohInterface("my_interface")
             >>> def handle_message(sample):
             ...     print(f"Received: {sample.value}")
@@ -167,6 +169,7 @@ def get_querier(
             configuration including congestion control, priority, and express delivery.
 
         Example:
+
             >>> interface = ZenohInterface("my_interface")
             >>> querier = interface.get_querier("api_client")
             >>> replies = querier.get("some/query")
@@ -204,6 +207,7 @@ def get_queryable(
             will be ignored. The handler should process queries and send responses.
 
         Example:
+
             >>> interface = ZenohInterface("my_interface")
             >>> def handle_query(query):
             ...     query.reply(zenoh.Sample("response/key", "response data"))
@@ -241,6 +245,7 @@ def is_port_in_use(port: int, host: str = "0.0.0.0") -> bool:
         port is already in use.
 
     Example:
+
         >>> if is_port_in_use(8080):
         ...     print("Port 8080 is busy")
         ... else:
diff --git a/make87/peripherals/camera/__init__.py b/make87/peripherals/camera/__init__.py
@@ -47,6 +47,7 @@ def __init__(
             protocol: Optional protocol specification (e.g., "V4L2", "GStreamer")
 
         Example:
+
             >>> camera = CameraPeripheral(
             ...     name="main_camera",
             ...     device_nodes=["/dev/video0"],
@@ -77,6 +78,7 @@ def from_config(cls, config: CameraPeripheralModel):
             CameraPeripheral instance configured according to the model
 
         Example:
+
             >>> from make87.models import CameraPeripheralModel
             >>> config = CameraPeripheralModel(...)
             >>> camera = CameraPeripheral.from_config(config)
diff --git a/make87/peripherals/generic_device/__init__.py b/make87/peripherals/generic_device/__init__.py
@@ -28,6 +28,7 @@ def __init__(self, name: str, device_node: str):
             device_node: The device node path (e.g., "/dev/ttyUSB0", "/dev/spidev0.0")
 
         Example:
+
             >>> device = GenericDevicePeripheral(
             ...     name="serial_port",
             ...     device_node="/dev/ttyUSB0"
@@ -50,6 +51,7 @@ def from_config(cls, config: GenericDevicePeripheralModel):
             GenericDevicePeripheral instance configured according to the model
 
         Example:
+
             >>> from make87.models import GenericDevicePeripheralModel
             >>> config = GenericDevicePeripheralModel(...)
             >>> device = GenericDevicePeripheral.from_config(config)
diff --git a/make87/peripherals/gpio/__init__.py b/make87/peripherals/gpio/__init__.py
@@ -48,6 +48,7 @@ def __init__(
                 the label will be used as the name.
 
         Example:
+
             >>> gpio = GpioPeripheral(
             ...     chip_name="gpiochip0",
             ...     label="Main GPIO Chip",
@@ -81,6 +82,7 @@ def from_config(cls, config: GpioPeripheralModel):
             GpioPeripheral instance configured according to the model
 
         Example:
+
             >>> from make87.models import GpioPeripheralModel
             >>> config = GpioPeripheralModel(...)
             >>> gpio = GpioPeripheral.from_config(config)
diff --git a/make87/peripherals/gpu/__init__.py b/make87/peripherals/gpu/__init__.py
@@ -44,6 +44,7 @@ def __init__(
             vram: Optional VRAM capacity in megabytes
 
         Example:
+
             >>> gpu = GpuPeripheral(
             ...     name="primary_gpu",
             ...     model="RTX 4090",
@@ -72,6 +73,7 @@ def from_config(cls, config: GpuPeripheralModel):
             GpuPeripheral instance configured according to the model
 
         Example:
+
             >>> from make87.models import GpuPeripheralModel
             >>> config = GpuPeripheralModel(...)
             >>> gpu = GpuPeripheral.from_config(config)
diff --git a/make87/peripherals/i2c/__init__.py b/make87/peripherals/i2c/__init__.py
@@ -42,6 +42,7 @@ def __init__(
                 each containing device address and other properties
 
         Example:
+
             >>> i2c = I2cPeripheral(
             ...     name="main_i2c",
             ...     bus_number=1,
@@ -71,6 +72,7 @@ def from_config(cls, config: I2cPeripheralModel):
             I2cPeripheral instance configured according to the model
 
         Example:
+
             >>> from make87.models import I2cPeripheralModel
             >>> config = I2cPeripheralModel(...)
             >>> i2c = I2cPeripheral.from_config(config)
diff --git a/make87/peripherals/isp/__init__.py b/make87/peripherals/isp/__init__.py
@@ -39,6 +39,7 @@ def __init__(
                 (e.g., ["/dev/v4l-subdev0"])
 
         Example:
+
             >>> isp = IspPeripheral(
             ...     name="main_isp",
             ...     supported_features=[
@@ -68,6 +69,7 @@ def from_config(cls, config: IspPeripheralModel):
             IspPeripheral instance configured according to the model
 
         Example:
+
             >>> from make87.models import IspPeripheralModel
             >>> config = IspPeripheralModel(...)
             >>> isp = IspPeripheral.from_config(config)
diff --git a/make87/peripherals/manager.py b/make87/peripherals/manager.py
@@ -67,6 +67,7 @@ def get_peripheral_by_name(self, name: str) -> PeripheralBase:
             KeyError: If no peripheral with the given name exists
 
         Example:
+
             >>> manager = PeripheralManager()
             >>> camera = manager.get_peripheral_by_name("main_camera")
             >>> gpio = manager.get_peripheral_by_name("status_led")
@@ -80,6 +81,7 @@ def list_peripherals(self):
             List of all PeripheralBase instances managed by this manager
 
         Example:
+
             >>> manager = PeripheralManager()
             >>> peripherals = manager.list_peripherals()
             >>> for peripheral in peripherals:
@@ -96,6 +98,7 @@ def __iter__(self):
             Iterator over PeripheralBase instances
 
         Example:
+
             >>> manager = PeripheralManager()
             >>> for peripheral in manager:
             ...     print(f"Found peripheral: {peripheral.name}")
@@ -115,6 +118,7 @@ def __getitem__(self, key):
             KeyError: If no peripheral with the given name exists
 
         Example:
+
             >>> manager = PeripheralManager()
             >>> camera = manager["main_camera"]
             >>> led = manager["status_led"]
@@ -128,6 +132,7 @@ def __len__(self):
             The number of peripheral instances managed by this manager
 
         Example:
+
             >>> manager = PeripheralManager()
             >>> print(f"Managing {len(manager)} peripherals")
         """
@@ -143,6 +148,7 @@ def __contains__(self, key):
             True if a peripheral with the given name exists, False otherwise
 
         Example:
+
             >>> manager = PeripheralManager()
             >>> if "main_camera" in manager:
             ...     print("Camera is available")
@@ -156,6 +162,7 @@ def items(self):
             Dictionary items view of name-peripheral pairs
 
         Example:
+
             >>> manager = PeripheralManager()
             >>> for name, peripheral in manager.items():
             ...     print(f"{name}: {type(peripheral).__name__}")
diff --git a/make87/peripherals/other/__init__.py b/make87/peripherals/other/__init__.py
diff --git a/make87/peripherals/real_sense/__init__.py b/make87/peripherals/real_sense/__init__.py
diff --git a/make87/peripherals/rendering/__init__.py b/make87/peripherals/rendering/__init__.py
diff --git a/make87/storage.py b/make87/storage.py
