Skip to content

Commit bae7e52

Browse files
authored
Merge pull request #8298 from jepler/canio-doc-mcp2515
canio: add a doc note about boards like CAN feather that use mcp2515
2 parents c07fff5 + 994bd23 commit bae7e52

File tree

2 files changed

+5
-1
lines changed

2 files changed

+5
-1
lines changed

conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -443,6 +443,7 @@ def autoapi_prepare_jinja_env(jinja_env):
443443
# Example configuration for intersphinx: refer to the Python standard library.
444444
intersphinx_mapping = {"python": ('https://docs.python.org/3/', None),
445445
"register": ('https://circuitpython.readthedocs.io/projects/register/en/latest/', None),
446+
"mcp2515": ('https://circuitpython.readthedocs.io/projects/mcp2515/en/latest/', None),
446447
"typing": ('https://circuitpython.readthedocs.io/projects/adafruit-circuitpython-typing/en/latest/', None)}
447448

448449
# Adapted from sphinxcontrib-redirects

shared-bindings/canio/__init__.c

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,10 @@
2727
//| """CAN bus access
2828
//|
2929
//| The `canio` module contains low level classes to support the CAN bus
30-
//| protocol.
30+
//| protocol on microcontrollers that have built-in CAN peripherals.
31+
//|
32+
//| Boards like the Adafruit RP2040 CAN Bus Feather that use an MCP2515 or
33+
//| compatible chip use the `mcp2515:adafruit_mcp2515` module instead.
3134
//|
3235
//| CAN and Listener classes change hardware state and should be deinitialized when they
3336
//| are no longer needed if the program continues after use. To do so, either

0 commit comments

Comments
 (0)