summaryrefslogtreecommitdiff
path: root/shared-bindings/supervisor
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/supervisor
parentc534a872a2b5a2d5e6b7543f56539afb24261443 (diff)
Swap sphinx to autoapi and the inline stubs
Diffstat (limited to 'shared-bindings/supervisor')
-rwxr-xr-xshared-bindings/supervisor/Runtime.c11
-rw-r--r--shared-bindings/supervisor/__init__.c30
2 files changed, 11 insertions, 30 deletions
diff --git a/shared-bindings/supervisor/Runtime.c b/shared-bindings/supervisor/Runtime.c
index 05921899c..a420d5b80 100755
--- a/shared-bindings/supervisor/Runtime.c
+++ b/shared-bindings/supervisor/Runtime.c
@@ -30,12 +30,7 @@
//TODO: add USB, REPL to description once they're operational
//| class Runtime:
-//| """.. currentmodule:: supervisor
-//|
-//| :class:`Runtime` --- Supervisor Runtime information
-//| ----------------------------------------------------
-//|
-//| Get current status of runtime objects.
+//| """Current status of runtime objects.
//|
//| Usage::
//|
@@ -50,7 +45,7 @@
//| ...
//|
-//| runtime.serial_connected: Any = ...
+//| serial_connected: bool = ...
//| """Returns the USB serial communication status (read-only).
//|
//| .. note::
@@ -78,7 +73,7 @@ const mp_obj_property_t supervisor_serial_connected_obj = {
};
-//| runtime.serial_bytes_available: Any = ...
+//| serial_bytes_available: int = ...
//| """Returns the whether any bytes are available to read
//| on the USB serial input. Allows for polling to see whether
//| to call the built-in input() or wait. (read-only)"""
diff --git a/shared-bindings/supervisor/__init__.c b/shared-bindings/supervisor/__init__.c
index 7fe6668f4..1830308b7 100644
--- a/shared-bindings/supervisor/__init__.c
+++ b/shared-bindings/supervisor/__init__.c
@@ -36,30 +36,16 @@
#include "shared-bindings/supervisor/__init__.h"
#include "shared-bindings/supervisor/Runtime.h"
-//| """:mod:`supervisor` --- Supervisor settings
-//| =================================================
-//|
-//| .. module:: supervisor
-//| :synopsis: Supervisor settings
-//| :platform: SAMD21/51 (All), nRF (Runtime only)
-//|
-//| The `supervisor` module. (TODO: expand description)
-//|
-//| Libraries
-//|
-//| .. toctree::
-//| :maxdepth: 3
-//|
-//| Runtime"""
+//| """Supervisor settings"""
//|
-//| runtime: Any = ...
-//| """Runtime information, such as `runtime.serial_connected`
+//| runtime: Runtime = ...
+//| """Runtime information, such as ``runtime.serial_connected``
//| (USB serial connection status).
//| This object is the sole instance of `supervisor.Runtime`."""
//|
-//| def enable_autoreload(self, ) -> Any:
+//| def enable_autoreload(self) -> None:
//| """Enable autoreload based on USB file write activity."""
//| ...
//|
@@ -69,7 +55,7 @@ STATIC mp_obj_t supervisor_enable_autoreload(void) {
}
MP_DEFINE_CONST_FUN_OBJ_0(supervisor_enable_autoreload_obj, supervisor_enable_autoreload);
-//| def disable_autoreload(self, ) -> Any:
+//| def disable_autoreload(self) -> None:
//| """Disable autoreload based on USB file write activity until
//| `enable_autoreload` is called."""
//| ...
@@ -80,7 +66,7 @@ STATIC mp_obj_t supervisor_disable_autoreload(void) {
}
MP_DEFINE_CONST_FUN_OBJ_0(supervisor_disable_autoreload_obj, supervisor_disable_autoreload);
-//| def set_rgb_status_brightness(self, ) -> Any:
+//| def set_rgb_status_brightness(self, brightness: int) -> None:
//| """Set brightness of status neopixel from 0-255
//| `set_rgb_status_brightness` is called."""
//| ...
@@ -96,7 +82,7 @@ STATIC mp_obj_t supervisor_set_rgb_status_brightness(mp_obj_t lvl){
}
MP_DEFINE_CONST_FUN_OBJ_1(supervisor_set_rgb_status_brightness_obj, supervisor_set_rgb_status_brightness);
-//| def reload(self, ) -> Any:
+//| def reload(self) -> None:
//| """Reload the main Python code and run it (equivalent to hitting Ctrl-D at the REPL)."""
//| ...
//|
@@ -107,7 +93,7 @@ STATIC mp_obj_t supervisor_reload(void) {
}
MP_DEFINE_CONST_FUN_OBJ_0(supervisor_reload_obj, supervisor_reload);
-//| def set_next_stack_limit(self, size: Any) -> Any:
+//| def set_next_stack_limit(self, size: int) -> None:
//| """Set the size of the stack for the next vm run. If its too large, the default will be used."""
//| ...
//|