Skip to content
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

Document Windows limitation on usb_midi.set_names(audio_control_interface_name=...) #9946

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Document Windows limitation on usb_midi.set_names(audio_control_interface_name=...) #9946

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
f64864e
shared-bindings/usb_midi/__init__.c: document Windows MIDI name lengt…
dhalbert Jan 10, 2025
02bbabe
update doc build for ports/analog
dhalbert Jan 10, 2025
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
2 changes: 1 addition & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(BASEOPTS)
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(BASEOPTS)

TRANSLATE_SOURCES = extmod lib main.c ports/atmel-samd ports/cxd56 ports/espressif ports/mimxrt10xx ports/nordic ports/raspberrypi ports/stm py shared-bindings shared-module supervisor
TRANSLATE_SOURCES = extmod lib main.c ports/atmel-samd ports/analog ports/cxd56 ports/espressif ports/mimxrt10xx ports/nordic ports/raspberrypi ports/renode ports/stm py shared-bindings shared-module supervisor
# Paths to exclude from TRANSLATE_SOURCES
# Each must be preceded by "-path"; if any wildcards, enclose in quotes.
# Separate by "-o" (Find's "or" operand)
Expand Down
2 changes: 2 additions & 0 deletions conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,8 @@ def autoapi_prepare_jinja_env(jinja_env):
"ports/*/boards",
"ports/*/common-hal",
"ports/*/supervisor",
"ports/analog/msdk",
"ports/analog/peripherals",
Comment on lines +200 to +201
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this frequently vexes me. perhaps we should explicitly list the documents we want with include_patterns instead (https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-include_patterns)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like that idea.

"ports/atmel-samd/asf4",
"ports/atmel-samd/asf4_conf",
"ports/atmel-samd/external_flash",
Expand Down
3 changes: 3 additions & 0 deletions shared-bindings/usb_midi/__init__.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,9 @@ static void set_name(mp_obj_t name_obj, qstr arg_name_qstr, char **custom_name_p
//| This method must be called in boot.py to have any effect.
//|
//| Not available on boards without native USB support.
//|
//| .. warning:: On Windows, if ``audio_control_interface_name`` is more than 31 characters long, Windows
//| will not recognize the device. This issue is not present on macOS or Linux.
//| """
//| ...
//|
Expand Down