diff --git a/dynamixelmotorsapi/__init__.py b/dynamixelmotorsapi/__init__.py index 6a66097..f333dce 100644 --- a/dynamixelmotorsapi/__init__.py +++ b/dynamixelmotorsapi/__init__.py @@ -1,3 +1,14 @@ +""" +This module provides an API for controlling Dynamixel motors using FTDI devices. + +You can list the FTDI devices connected to your computer using the following functions: +- `dynamixelmotorsapi.listFTDIDevices()`: Lists all FTDI devices connected to the computer. +- `dynamixelmotorsapi.listUnusedFTDIDevices()`: Lists FTDI devices that are not currently used by any instance of DynamixelMotors in this process. +- `dynamixelmotorsapi.listUsedFTDIDevices()`: Lists FTDI devices that are currently used by an instance of DynamixelMotors in this process. + + +""" + from importlib.resources import files from .dynamixelmotors import DynamixelMotors, motorgroup diff --git a/pyproject.toml b/pyproject.toml index 2413ae2..97a7a19 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -44,7 +44,7 @@ type = "python" type = "filter" skip_empty_modules = true exclude_private = true -expression = "not name.startswith('_') and '_' not in obj.location.filename and default() and 'scraper' not in name" +expression = "not name.startswith('_') and '_' not in obj.location.filename and default() and 'scraper' not in name or ('__init__' in obj.location.filename and default())" [[tool.pydoc-markdown.processors]] type="smart"