summaryrefslogtreecommitdiff
path: root/shared-bindings/busio
diff options
context:
space:
mode:
Diffstat (limited to 'shared-bindings/busio')
-rw-r--r--shared-bindings/busio/I2C.c5
-rw-r--r--shared-bindings/busio/OneWire.c5
-rw-r--r--shared-bindings/busio/SPI.c7
-rw-r--r--shared-bindings/busio/UART.c5
-rw-r--r--shared-bindings/busio/__init__.c17
5 files changed, 6 insertions, 33 deletions
diff --git a/shared-bindings/busio/I2C.c b/shared-bindings/busio/I2C.c
index 8ae3658ee..7e8af765f 100644
--- a/shared-bindings/busio/I2C.c
+++ b/shared-bindings/busio/I2C.c
@@ -37,10 +37,7 @@
#include "supervisor/shared/translate.h"
//| class I2C:
-//| """.. currentmodule:: busio
-//|
-//| :class:`I2C` --- Two wire serial protocol
-//| ------------------------------------------"""
+//| """Two wire serial protocol"""
//|
//| def __init__(self, scl: microcontroller.Pin, sda: microcontroller.Pin, *, frequency: int = 400000, timeout: int = 255):
//|
diff --git a/shared-bindings/busio/OneWire.c b/shared-bindings/busio/OneWire.c
index 556e567ef..723cc031a 100644
--- a/shared-bindings/busio/OneWire.c
+++ b/shared-bindings/busio/OneWire.c
@@ -35,10 +35,7 @@
#include "shared-bindings/util.h"
//| class OneWire:
-//| """.. currentmodule:: busio
-//|
-//| :class:`OneWire` -- Lowest-level of the Maxim OneWire protocol
-//| ================================================================="""
+//| """Lowest-level of the Maxim OneWire protocol"""
//|
//| def __init__(self, pin: microcontroller.Pin):
//| """(formerly Dallas Semi) OneWire protocol.
diff --git a/shared-bindings/busio/SPI.c b/shared-bindings/busio/SPI.c
index 5b1881702..2ba9a4c22 100644
--- a/shared-bindings/busio/SPI.c
+++ b/shared-bindings/busio/SPI.c
@@ -42,10 +42,7 @@
//| class SPI:
-//| """.. currentmodule:: busio
-//|
-//| `SPI` -- a 3-4 wire serial protocol
-//| -----------------------------------------------
+//| """A 3-4 wire serial protocol
//|
//| SPI is a serial protocol that has exclusive pins for data in and out of the
//| master. It is typically faster than :py:class:`~busio.I2C` because a
@@ -147,7 +144,7 @@ STATIC void check_for_deinit(busio_spi_obj_t *self) {
//| def configure(self, *, baudrate: int = 100000, polarity: int = 0, phase: int = 0, bits: int = 8) -> Any:
//| """Configures the SPI bus. The SPI object must be locked.
//|
-//| :param int baudrate: the desired clock rate in Hertz. The actual clock rate may be higher or lower
+//| :param int baudrate: the desired clock rate in Hertz. The actual clock rate may be higher or lower
//| due to the granularity of available clock settings.
//| Check the `frequency` attribute for the actual clock rate.
//| :param int polarity: the base state of the clock line (0 or 1)
diff --git a/shared-bindings/busio/UART.c b/shared-bindings/busio/UART.c
index 5984194a9..d4642225c 100644
--- a/shared-bindings/busio/UART.c
+++ b/shared-bindings/busio/UART.c
@@ -43,10 +43,7 @@
// #define STREAM_DEBUG(...) mp_printf(&mp_plat_print __VA_OPT__(,) __VA_ARGS__)
//| class UART:
-//| """.. currentmodule:: busio
-//|
-//| :class:`UART` -- a bidirectional serial protocol
-//| ================================================="""
+//| """A bidirectional serial protocol"""
//| def __init__(self, tx: microcontroller.Pin, rx: microcontroller.Pin, *, baudrate: int = 9600, bits: int = 8, parity: Parity = None, stop: int = 1, timeout: float = 1, receiver_buffer_size: int = 64):
//| """A common bidirectional serial protocol that uses an an agreed upon speed
//| rather than a shared clock line.
diff --git a/shared-bindings/busio/__init__.c b/shared-bindings/busio/__init__.c
index 212b3218c..04632c2f4 100644
--- a/shared-bindings/busio/__init__.c
+++ b/shared-bindings/busio/__init__.c
@@ -38,12 +38,7 @@
#include "py/runtime.h"
-//| """:mod:`busio` --- Hardware accelerated behavior
-//| =================================================
-//|
-//| .. module:: busio
-//| :synopsis: Hardware accelerated behavior
-//| :platform: SAMD21
+//| """Hardware accelerated external bus access
//|
//| The `busio` module contains classes to support a variety of serial
//| protocols.
@@ -54,16 +49,6 @@
//| then a RuntimeError will be raised. Use the `bitbangio` module to explicitly
//| bitbang a serial protocol on any general purpose pins.
//|
-//| Libraries
-//|
-//| .. toctree::
-//| :maxdepth: 3
-//|
-//| I2C
-//| OneWire
-//| SPI
-//| UART
-//|
//| All classes change hardware state and should be deinitialized when they
//| are no longer needed if the program continues after use. To do so, either
//| call :py:meth:`!deinit` or use a context manager. See