summaryrefslogtreecommitdiff
path: root/shared-bindings/microcontroller
diff options
context:
space:
mode:
authorScott Shawcroft <scott@tannewt.org>2020-05-12 17:15:28 -0700
committerScott Shawcroft <scott@tannewt.org>2020-05-12 17:28:24 -0700
commit4e8de3c554024d3ac89e9ee77b958a6932a64bec (patch)
tree4606c0cf69cef8a033aa2d95fab0811ddf49123a /shared-bindings/microcontroller
parentc534a872a2b5a2d5e6b7543f56539afb24261443 (diff)
Swap sphinx to autoapi and the inline stubs
Diffstat (limited to 'shared-bindings/microcontroller')
-rw-r--r--shared-bindings/microcontroller/Pin.c7
-rw-r--r--shared-bindings/microcontroller/Processor.c11
-rw-r--r--shared-bindings/microcontroller/RunMode.c5
-rw-r--r--shared-bindings/microcontroller/__init__.c20
4 files changed, 8 insertions, 35 deletions
diff --git a/shared-bindings/microcontroller/Pin.c b/shared-bindings/microcontroller/Pin.c
index cad0d67b1..765e602e5 100644
--- a/shared-bindings/microcontroller/Pin.c
+++ b/shared-bindings/microcontroller/Pin.c
@@ -34,12 +34,7 @@
#include "supervisor/shared/translate.h"
//| class Pin:
-//| """.. currentmodule:: microcontroller
-//|
-//| :class:`Pin` --- Pin reference
-//| ------------------------------------------
-//|
-//| Identifies an IO pin on the microcontroller."""
+//| """Identifies an IO pin on the microcontroller."""
//|
//| def __init__(self, ):
//| """Identifies an IO pin on the microcontroller. They are fixed by the
diff --git a/shared-bindings/microcontroller/Processor.c b/shared-bindings/microcontroller/Processor.c
index dedb5a27c..c4b249124 100644
--- a/shared-bindings/microcontroller/Processor.c
+++ b/shared-bindings/microcontroller/Processor.c
@@ -35,12 +35,7 @@
#include "py/runtime.h"
//| class Processor:
-//| """.. currentmodule:: microcontroller
-//|
-//| :class:`Processor` --- Microcontroller CPU information and control
-//| ------------------------------------------------------------------
-//|
-//| Get information about the microcontroller CPU and control it.
+//| """Microcontroller CPU information and control
//|
//| Usage::
//|
@@ -55,8 +50,8 @@
//| ...
//|
-//| frequency: Any = ...
-//| """The CPU operating frequency as an `int`, in Hertz. (read-only)"""
+//| frequency: int = ...
+//| """The CPU operating frequency in Hertz. (read-only)"""
//|
STATIC mp_obj_t mcu_processor_get_frequency(mp_obj_t self) {
return mp_obj_new_int_from_uint(common_hal_mcu_processor_get_frequency());
diff --git a/shared-bindings/microcontroller/RunMode.c b/shared-bindings/microcontroller/RunMode.c
index df3ff4186..6db315d8d 100644
--- a/shared-bindings/microcontroller/RunMode.c
+++ b/shared-bindings/microcontroller/RunMode.c
@@ -27,10 +27,7 @@
#include "shared-bindings/microcontroller/RunMode.h"
//| class RunMode:
-//| """.. currentmodule:: microcontroller
-//|
-//| :class:`RunMode` -- run state of the microcontroller
-//| ============================================================="""
+//| """run state of the microcontroller"""
//|
//| def __init__(self, ):
//| """Enum-like class to define the run mode of the microcontroller and
diff --git a/shared-bindings/microcontroller/__init__.c b/shared-bindings/microcontroller/__init__.c
index 75b763980..21e1c90a9 100644
--- a/shared-bindings/microcontroller/__init__.c
+++ b/shared-bindings/microcontroller/__init__.c
@@ -42,27 +42,13 @@
#include "py/runtime.h"
#include "supervisor/shared/translate.h"
-//| """:mod:`microcontroller` --- Pin references and cpu functionality
-//| ================================================================
-//|
-//| .. module:: microcontroller
-//| :synopsis: Pin references and core functionality
-//| :platform: SAMD21, ESP8266
+//| """Pin references and cpu functionality
//|
//| The `microcontroller` module defines the pins from the perspective of the
-//| microcontroller. See `board` for board-specific pin mappings.
-//|
-//| Libraries
-//|
-//| .. toctree::
-//| :maxdepth: 3
-//|
-//| Pin
-//| Processor
-//| RunMode"""
+//| microcontroller. See `board` for board-specific pin mappings."""
//|
-//| cpu: Any = ...
+//| cpu: Processor = ...
//| """CPU information and control, such as ``cpu.temperature`` and ``cpu.frequency``
//| (clock frequency).
//| This object is the sole instance of `microcontroller.Processor`."""