Skip to content

Adds list devices to the documentation #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
EulalieCoevoet merged 2 commits into from
May 28, 2026
Merged

Adds list devices to the documentation #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ac09984
Adds list devices to the documentation
HanaeRateau May 28, 2026
1086820
Apply suggestion from @EulalieCoevoet
EulalieCoevoet May 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions dynamixelmotorsapi/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
Loading