From ac09984990cfa4d99a0bcfb4b4d4992e16d75af3 Mon Sep 17 00:00:00 2001 From: HanaeRateau Date: Thu, 28 May 2026 17:55:35 +0200 Subject: [PATCH 1/2] Adds list devices to the documentation --- dynamixelmotorsapi/__init__.py | 11 +++++++++++ pyproject.toml | 4 ++-- 2 files changed, 13 insertions(+), 2 deletions(-) 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..06e8e84 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" @@ -64,7 +64,7 @@ add_full_prefix = false insert_header_anchors = false classdef_code_block = true signature_code_block = true -signature_in_header = false +signature_in_header = true code_headers = false use_fixed_header_levels = true render_toc = false From 1086820d16107a70be3591031f9bb97123ff0623 Mon Sep 17 00:00:00 2001 From: EulalieCoevoet Date: Thu, 28 May 2026 20:36:45 +0200 Subject: [PATCH 2/2] Apply suggestion from @EulalieCoevoet --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index 06e8e84..97a7a19 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -64,7 +64,7 @@ add_full_prefix = false insert_header_anchors = false classdef_code_block = true signature_code_block = true -signature_in_header = true +signature_in_header = false code_headers = false use_fixed_header_levels = true render_toc = false