summaryrefslogtreecommitdiff
path: root/shared-bindings/displayio
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/displayio
parentc534a872a2b5a2d5e6b7543f56539afb24261443 (diff)
Swap sphinx to autoapi and the inline stubs
Diffstat (limited to 'shared-bindings/displayio')
-rw-r--r--shared-bindings/displayio/Bitmap.c7
-rw-r--r--shared-bindings/displayio/ColorConverter.c7
-rw-r--r--shared-bindings/displayio/Display.c5
-rw-r--r--shared-bindings/displayio/EPaperDisplay.c5
-rw-r--r--shared-bindings/displayio/FourWire.c7
-rw-r--r--shared-bindings/displayio/Group.c7
-rw-r--r--shared-bindings/displayio/I2CDisplay.c7
-rw-r--r--shared-bindings/displayio/OnDiskBitmap.c7
-rw-r--r--shared-bindings/displayio/Palette.c7
-rw-r--r--shared-bindings/displayio/ParallelBus.c7
-rw-r--r--shared-bindings/displayio/Shape.c7
-rw-r--r--shared-bindings/displayio/TileGrid.c5
-rw-r--r--shared-bindings/displayio/__init__.c27
13 files changed, 14 insertions, 91 deletions
diff --git a/shared-bindings/displayio/Bitmap.c b/shared-bindings/displayio/Bitmap.c
index d15c3b107..a52840f2e 100644
--- a/shared-bindings/displayio/Bitmap.c
+++ b/shared-bindings/displayio/Bitmap.c
@@ -37,12 +37,7 @@
#include "supervisor/shared/translate.h"
//| class Bitmap:
-//| """.. currentmodule:: displayio
-//|
-//| :class:`Bitmap` -- Stores values in a 2D array
-//| ==========================================================================
-//|
-//| Stores values of a certain size in a 2D array"""
+//| """Stores values of a certain size in a 2D array"""
//|
//| def __init__(self, width: int, height: int, value_count: int):
//| """Create a Bitmap object with the given fixed size. Each pixel stores a value that is used to
diff --git a/shared-bindings/displayio/ColorConverter.c b/shared-bindings/displayio/ColorConverter.c
index 1d6e5a0cc..505e9f766 100644
--- a/shared-bindings/displayio/ColorConverter.c
+++ b/shared-bindings/displayio/ColorConverter.c
@@ -37,12 +37,7 @@
#include "supervisor/shared/translate.h"
//| class ColorConverter:
-//| """.. currentmodule:: displayio
-//|
-//| :class:`ColorConverter` -- Converts one color format to another
-//| =========================================================================================
-//|
-//| Converts one color format to another."""
+//| """Converts one color format to another."""
//|
//| def __init__(self, *, dither: bool = False):
//| """Create a ColorConverter object to convert color formats. Only supports RGB888 to RGB565
diff --git a/shared-bindings/displayio/Display.c b/shared-bindings/displayio/Display.c
index 12abec1c8..62ef0f5d0 100644
--- a/shared-bindings/displayio/Display.c
+++ b/shared-bindings/displayio/Display.c
@@ -40,10 +40,7 @@
#include "supervisor/shared/translate.h"
//| class Display:
-//| """.. currentmodule:: displayio
-//|
-//| :class:`Display` -- Manage updating a display over a display bus
-//| ==========================================================================
+//| """Manage updating a display over a display bus
//|
//| This initializes a display and connects it into CircuitPython. Unlike other
//| objects in CircuitPython, Display objects live until `displayio.release_displays()`
diff --git a/shared-bindings/displayio/EPaperDisplay.c b/shared-bindings/displayio/EPaperDisplay.c
index 8b03ddc06..8b77e4df3 100644
--- a/shared-bindings/displayio/EPaperDisplay.c
+++ b/shared-bindings/displayio/EPaperDisplay.c
@@ -40,10 +40,7 @@
#include "supervisor/shared/translate.h"
//| class EPaperDisplay:
-//| """.. currentmodule:: displayio
-//|
-//| :class:`EPaperDisplay` -- Manage updating an epaper display over a display bus
-//| ==============================================================================
+//| """Manage updating an epaper display over a display bus
//|
//| This initializes an epaper display and connects it into CircuitPython. Unlike other
//| objects in CircuitPython, EPaperDisplay objects live until `displayio.release_displays()`
diff --git a/shared-bindings/displayio/FourWire.c b/shared-bindings/displayio/FourWire.c
index 649045039..5ee4ec5a9 100644
--- a/shared-bindings/displayio/FourWire.c
+++ b/shared-bindings/displayio/FourWire.c
@@ -39,12 +39,7 @@
#include "supervisor/shared/translate.h"
//| class FourWire:
-//| """.. currentmodule:: displayio
-//|
-//| :class:`FourWire` -- Manage updating a display over SPI four wire protocol
-//| ==========================================================================
-//|
-//| Manage updating a display over SPI four wire protocol in the background while Python code runs.
+//| """Manage updating a display over SPI four wire protocol in the background while Python code runs.
//| It doesn't handle display initialization."""
//|
//| def __init__(self, spi_bus: busio.SPI, *, command: microcontroller.Pin, chip_select: microcontroller.Pin, reset: microcontroller.Pin = None, baudrate: int = 24000000, polarity: int = 0, phase: int = 0):
diff --git a/shared-bindings/displayio/Group.c b/shared-bindings/displayio/Group.c
index 36e137dc9..b6f96883b 100644
--- a/shared-bindings/displayio/Group.c
+++ b/shared-bindings/displayio/Group.c
@@ -36,12 +36,7 @@
#include "supervisor/shared/translate.h"
//| class Group:
-//| """.. currentmodule:: displayio
-//|
-//| :class:`Group` -- Group together sprites and subgroups
-//| ==========================================================================
-//|
-//| Manage a group of sprites and groups and how they are inter-related."""
+//| """Manage a group of sprites and groups and how they are inter-related."""
//|
//| def __init__(self, *, max_size: int = 4, scale: int = 1, x: int = 0, y: int = 0):
//| """Create a Group of a given size and scale. Scale is in one dimension. For example, scale=2
diff --git a/shared-bindings/displayio/I2CDisplay.c b/shared-bindings/displayio/I2CDisplay.c
index e2402dc49..0cfac6672 100644
--- a/shared-bindings/displayio/I2CDisplay.c
+++ b/shared-bindings/displayio/I2CDisplay.c
@@ -39,12 +39,7 @@
#include "supervisor/shared/translate.h"
//| class I2CDisplay:
-//| """.. currentmodule:: displayio
-//|
-//| :class:`I2CDisplay` -- Manage updating a display over I2C
-//| ==========================================================================
-//|
-//| Manage updating a display over I2C in the background while Python code runs.
+//| """Manage updating a display over I2C in the background while Python code runs.
//| It doesn't handle display initialization."""
//|
//| def __init__(self, i2c_bus: busio.I2C, *, device_address: int, reset: microcontroller.Pin = None):
diff --git a/shared-bindings/displayio/OnDiskBitmap.c b/shared-bindings/displayio/OnDiskBitmap.c
index 95c890c3b..170873653 100644
--- a/shared-bindings/displayio/OnDiskBitmap.c
+++ b/shared-bindings/displayio/OnDiskBitmap.c
@@ -34,12 +34,7 @@
#include "shared-bindings/displayio/OnDiskBitmap.h"
//| class OnDiskBitmap:
-//| """.. currentmodule:: displayio
-//|
-//| :class:`OnDiskBitmap` -- Loads pixels straight from disk
-//| ==========================================================================
-//|
-//| Loads values straight from disk. This minimizes memory use but can lead to
+//| """Loads values straight from disk. This minimizes memory use but can lead to
//| much slower pixel load times. These load times may result in frame tearing where only part of
//| the image is visible.
//|
diff --git a/shared-bindings/displayio/Palette.c b/shared-bindings/displayio/Palette.c
index 5df11d2b1..871b2b06a 100644
--- a/shared-bindings/displayio/Palette.c
+++ b/shared-bindings/displayio/Palette.c
@@ -43,12 +43,7 @@
//| class Palette:
-//| """.. currentmodule:: displayio
-//|
-//| :class:`Palette` -- Stores a mapping from bitmap pixel palette_indexes to display colors
-//| =========================================================================================
-//|
-//| Map a pixel palette_index to a full color. Colors are transformed to the display's format internally to
+//| """Map a pixel palette_index to a full color. Colors are transformed to the display's format internally to
//| save memory."""
//|
//| def __init__(self, color_count: int):
diff --git a/shared-bindings/displayio/ParallelBus.c b/shared-bindings/displayio/ParallelBus.c
index cedcf1de5..eb75ecc03 100644
--- a/shared-bindings/displayio/ParallelBus.c
+++ b/shared-bindings/displayio/ParallelBus.c
@@ -38,12 +38,7 @@
#include "supervisor/shared/translate.h"
//| class ParallelBus:
-//| """.. currentmodule:: displayio
-//|
-//| :class:`ParallelBus` -- Manage updating a display over 8-bit parallel bus
-//| ==============================================================================
-//|
-//| Manage updating a display over 8-bit parallel bus in the background while Python code runs. This
+//| """Manage updating a display over 8-bit parallel bus in the background while Python code runs. This
//| protocol may be refered to as 8080-I Series Parallel Interface in datasheets. It doesn't handle
//| display initialization."""
//|
diff --git a/shared-bindings/displayio/Shape.c b/shared-bindings/displayio/Shape.c
index 0f22bb2a3..fce89c771 100644
--- a/shared-bindings/displayio/Shape.c
+++ b/shared-bindings/displayio/Shape.c
@@ -35,12 +35,7 @@
#include "supervisor/shared/translate.h"
//| class Shape:
-//| """.. currentmodule:: displayio
-//|
-//| :class:`Shape` -- Represents a shape by defining its bounds on each row
-//| ==========================================================================
-//|
-//| Represents any shape made by defining boundaries that may be mirrored."""
+//| """Represents a shape made by defining boundaries that may be mirrored."""
//|
//| def __init__(self, width: int, height: int, *, mirror_x: bool = False, mirror_y: bool = False):
//| """Create a Shape object with the given fixed size. Each pixel is one bit and is stored by the
diff --git a/shared-bindings/displayio/TileGrid.c b/shared-bindings/displayio/TileGrid.c
index e7410e4b6..01fba46a5 100644
--- a/shared-bindings/displayio/TileGrid.c
+++ b/shared-bindings/displayio/TileGrid.c
@@ -41,10 +41,7 @@
#include "supervisor/shared/translate.h"
//| class TileGrid:
-//| """.. currentmodule:: displayio
-//|
-//| :class:`TileGrid` -- A grid of tiles sourced out of one bitmap
-//| ==========================================================================
+//| """A grid of tiles sourced out of one bitmap
//|
//| Position a grid of tiles sourced from a bitmap and pixel_shader combination. Multiple grids
//| can share bitmaps and pixel shaders.
diff --git a/shared-bindings/displayio/__init__.c b/shared-bindings/displayio/__init__.c
index 37c025329..b791336b5 100644
--- a/shared-bindings/displayio/__init__.c
+++ b/shared-bindings/displayio/__init__.c
@@ -43,33 +43,10 @@
#include "shared-bindings/displayio/Shape.h"
#include "shared-bindings/displayio/TileGrid.h"
-//| """:mod:`displayio` --- Native display driving
-//| =========================================================================
-//|
-//| .. module:: displayio
-//| :synopsis: Native helpers for driving displays
-//| :platform: SAMD21, SAMD51, nRF52
+//| """Native helpers for driving displays
//|
//| The `displayio` module contains classes to manage display output
-//| including synchronizing with refresh rates and partial updating.
-//|
-//| Libraries
-//|
-//| .. toctree::
-//| :maxdepth: 3
-//|
-//| Bitmap
-//| ColorConverter
-//| Display
-//| EPaperDisplay
-//| FourWire
-//| Group
-//| I2CDisplay
-//| OnDiskBitmap
-//| Palette
-//| ParallelBus
-//| Shape
-//| TileGrid"""
+//| including synchronizing with refresh rates and partial updating."""
//|