From 994bd2371fa89f4075cd83614f9e2d359fa32747 Mon Sep 17 00:00:00 2001 From: Jeff Epler Date: Sat, 19 Aug 2023 12:07:07 -0500 Subject: [PATCH] canio: add a doc note about boards like CAN feather that use mcp2515 --- conf.py | 1 + shared-bindings/canio/__init__.c | 5 ++++- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/conf.py b/conf.py index 645961c457..ba6e01f6a9 100644 --- a/conf.py +++ b/conf.py @@ -443,6 +443,7 @@ texinfo_documents = [ # Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = {"cpython": ('https://docs.python.org/3/', None), "register": ('https://circuitpython.readthedocs.io/projects/register/en/latest/', None), + "mcp2515": ('https://circuitpython.readthedocs.io/projects/mcp2515/en/latest/', None), "typing": ('https://circuitpython.readthedocs.io/projects/adafruit-circuitpython-typing/en/latest/', None)} # Adapted from sphinxcontrib-redirects diff --git a/shared-bindings/canio/__init__.c b/shared-bindings/canio/__init__.c index ecef7ebde6..42edd68e38 100644 --- a/shared-bindings/canio/__init__.c +++ b/shared-bindings/canio/__init__.c @@ -27,7 +27,10 @@ //| """CAN bus access //| //| The `canio` module contains low level classes to support the CAN bus -//| protocol. +//| protocol on microcontrollers that have built-in CAN peripherals. +//| +//| Boards like the Adafruit RP2040 CAN Bus Feather that use an MCP2515 or +//| compatible chip use the `mcp2515:adafruit_mcp2515` module instead. //| //| CAN and Listener classes change hardware state and should be deinitialized when they //| are no longer needed if the program continues after use. To do so, either