correcting_rtype_documentation_sphinx

adafruit_character_lcd/character_lcd.py

@@ -17,13 +17,15 @@
 
 **Hardware:**
 
-* `Adafruit Character LCDs <http://www.adafruit.com/category/63_96>`_
+* `Adafruit Character LCDs
+  <http://www.adafruit.com/category/63_96>`_
 
 **Software and Dependencies:**
 
-* Adafruit CircuitPython firmware:
-  https://github.com/adafruit/circuitpython/releases
-* Adafruit's Bus Device library (when using I2C/SPI):
+* Adafruit CircuitPython firmware for the supported boards:
+  https://circuitpython.org/downloads
+
+* Adafruit's Bus Device library:
   https://github.com/adafruit/Adafruit_CircuitPython_BusDevice
 
 """
@@ -171,10 +173,9 @@ def clear(self):
 
             import time
             import board
-            import busio
             import adafruit_character_lcd.character_lcd_i2c as character_lcd
 
-            i2c = busio.I2C(board.SCL, board.SDA)
+            i2c = board.I2C()  # uses board.SCL and board.SDA
             lcd = character_lcd.Character_LCD_I2C(i2c, 16, 2)
 
             lcd.message = "Hello, world!"
@@ -208,10 +209,9 @@ def cursor(self):
 
             import time
             import board
-            import busio
             import adafruit_character_lcd.character_lcd_i2c as character_lcd
 
-            i2c = busio.I2C(board.SCL, board.SDA)
+            i2c = board.I2C()  # uses board.SCL and board.SDA
             lcd = character_lcd.Character_LCD_I2C(i2c, 16, 2)
 
             lcd.cursor = True
@@ -259,10 +259,9 @@ def blink(self):
 
             import time
             import board
-            import busio
             import adafruit_character_lcd.character_lcd_i2c as character_lcd
 
-            i2c = busio.I2C(board.SCL, board.SDA)
+            i2c = board.I2C()  # uses board.SCL and board.SDA
             lcd = character_lcd.Character_LCD_I2C(i2c, 16, 2)
 
             lcd.blink = True
@@ -291,10 +290,9 @@ def display(self):
 
             import time
             import board
-            import busio
             import adafruit_character_lcd.character_lcd_i2c as character_lcd
 
-            i2c = busio.I2C(board.SCL, board.SDA)
+            i2c = board.I2C()  # uses board.SCL and board.SDA
             lcd = character_lcd.Character_LCD_I2C(i2c, 16, 2)
 
             lcd.message = "Hello, world!"
@@ -326,10 +324,9 @@ def message(self):
 
             import time
             import board
-            import busio
             import adafruit_character_lcd.character_lcd_i2c as character_lcd
 
-            i2c = busio.I2C(board.SCL, board.SDA)
+            i2c = board.I2C()  # uses board.SCL and board.SDA
             lcd = character_lcd.Character_LCD_I2C(i2c, 16, 2)
 
             lcd.message = "Hello, world!"
@@ -389,10 +386,9 @@ def move_left(self):
 
             import time
             import board
-            import busio
             import adafruit_character_lcd.character_lcd_i2c as character_lcd
 
-            i2c = busio.I2C(board.SCL, board.SDA)
+            i2c = board.I2C()  # uses board.SCL and board.SDA
             lcd = character_lcd.Character_LCD_I2C(i2c, 16, 2)
 
             scroll_message = "<-- Scroll"
@@ -413,10 +409,9 @@ def move_right(self):
 
             import time
             import board
-            import busio
             import adafruit_character_lcd.character_lcd_i2c as character_lcd
 
-            i2c = busio.I2C(board.SCL, board.SDA)
+            i2c = board.I2C()  # uses board.SCL and board.SDA
             lcd = character_lcd.Character_LCD_I2C(i2c, 16, 2)
 
             scroll_message = "Scroll -->"
@@ -441,10 +436,9 @@ def text_direction(self):
 
             import time
             import board
-            import busio
             import adafruit_character_lcd.character_lcd_i2c as character_lcd
 
-            i2c = busio.I2C(board.SCL, board.SDA)
+            i2c = board.I2C()  # uses board.SCL and board.SDA
             lcd = character_lcd.Character_LCD_I2C(i2c, 16, 2)
 
             lcd.text_direction = lcd.RIGHT_TO_LEFT
@@ -583,10 +577,9 @@ def backlight(self):
 
             import time
             import board
-            import busio
             import adafruit_character_lcd.character_lcd_i2c as character_lcd
 
-            i2c = busio.I2C(board.SCL, board.SDA)
+            i2c = board.I2C()  # uses board.SCL and board.SDA
 
             lcd = character_lcd.Character_LCD_I2C(i2c, 16, 2)
 
@@ -620,12 +613,9 @@ class Character_LCD_RGB(Character_LCD):
     :param ~digitalio.DigitalInOut db7: The data line 7
     :param columns: The columns on the charLCD
     :param lines: The lines on the charLCD
-    :param red: Red RGB Anode
-    :type red: ~pwmio.PWMOut or ~digitalio.DigitalInOut
-    :param green: Green RGB Anode
-    :type green: ~pwmio.PWMOut or ~digitalio.DigitalInOut
-    :param blue: Blue RGB Anode
-    :type blue: ~pwmio.PWMOut or ~digitalio.DigitalInOut
+    :param ~pwmio.PWMOut,~digitalio.DigitalInOut red: Red RGB Anode
+    :param ~pwmio.PWMOut,~digitalio.DigitalInOut green: Green RGB Anode
+    :param ~pwmio.PWMOut,~digitalio.DigitalInOut blue: Blue RGB Anode
     :param ~digitalio.DigitalInOut read_write: The rw pin. Determines whether to read to or
         write from the display. Not necessary if only writing to the display. Used on shield.
 
@@ -687,10 +677,9 @@ def color(self):
 
             import time
             import board
-            import busio
             import adafruit_character_lcd.character_lcd_rgb_i2c as character_lcd
 
-            i2c = busio.I2C(board.SCL, board.SDA)
+            i2c = board.I2C()  # uses board.SCL and board.SDA
 
             lcd = character_lcd.Character_LCD_RGB_I2C(i2c, 16, 2)
 

adafruit_character_lcd/character_lcd_i2c.py

@@ -15,13 +15,15 @@
 
 **Hardware:**
 
-* `I2C / SPI character LCD backpack <https://www.adafruit.com/product/292>`_
+* `I2C / SPI character LCD backpack
+  <https://www.adafruit.com/product/292>`_ (Product ID: 292)
 
 **Software and Dependencies:**
 
-* Adafruit CircuitPython firmware:
-  https://github.com/adafruit/circuitpython/releases
-* Adafruit's Bus Device library (when using I2C/SPI):
+* Adafruit CircuitPython firmware for the supported boards:
+  https://circuitpython.org/downloads
+
+* Adafruit's Bus Device library:
   https://github.com/adafruit/Adafruit_CircuitPython_BusDevice
 
 """
@@ -44,10 +46,9 @@ class Character_LCD_I2C(Character_LCD_Mono):
     .. code-block:: python
 
         import board
-        import busio
         from adafruit_character_lcd.character_lcd_i2c import Character_LCD_I2C
 
-        i2c = busio.I2C(board.SCL, board.SDA)
+        i2c = board.I2C()  # uses board.SCL and board.SDA
         lcd = Character_LCD_I2C(i2c, 16, 2)
     """
 

adafruit_character_lcd/character_lcd_rgb_i2c.py

@@ -16,22 +16,23 @@
 **Hardware:**
 
 * `RGB LCD Shield Kit w/ 16x2 Character Display - Negative Display
-  <https://www.adafruit.com/product/714>`_
+  <https://www.adafruit.com/product/714>`_ (Product ID: 714)
 
 * `RGB LCD Shield Kit w/ 16x2 Character Display - Positive Display
-  <https://www.adafruit.com/product/716>`_
+  <https://www.adafruit.com/product/716>`_ (Product ID: 716)
 
 * `Adafruit RGB Negative 16x2 LCD+Keypad Kit for Raspberry Pi
-  <https://www.adafruit.com/product/1110>`_
+  <https://www.adafruit.com/product/1110>`_ (Product ID: 1110)
 
 * `Adafruit RGB Positive 16x2 LCD+Keypad Kit for Raspberry Pi
-  <https://www.adafruit.com/product/1109>`_
+  <https://www.adafruit.com/product/1109>`_ (Product ID: 1109)
 
 **Software and Dependencies:**
 
-* Adafruit CircuitPython firmware:
-  https://github.com/adafruit/circuitpython/releases
-* Adafruit's Bus Device library (when using I2C/SPI):
+* Adafruit CircuitPython firmware for the supported boards:
+  https://circuitpython.org/downloads
+
+* Adafruit's Bus Device library:
   https://github.com/adafruit/Adafruit_CircuitPython_BusDevice
 
 """
@@ -54,10 +55,9 @@ class Character_LCD_RGB_I2C(Character_LCD_RGB):
     .. code-block:: python
 
         import board
-        import busio
         from adafruit_character_lcd.character_lcd_rgb_i2c import Character_LCD_RGB_I2C
 
-        i2c = busio.I2C(board.SCL, board.SDA)
+        i2c = board.I2C()  # uses board.SCL and board.SDA
         lcd = Character_LCD_RGB_I2C(i2c, 16, 2)
 
     """
@@ -115,10 +115,9 @@ def left_button(self):
         .. code-block:: python
 
             import board
-            import busio
             from adafruit_character_lcd.character_lcd_rgb_i2c import Character_LCD_RGB_I2C
 
-            i2c = busio.I2C(board.SCL, board.SDA)
+            i2c = board.I2C()  # uses board.SCL and board.SDA
             lcd = Character_LCD_RGB_I2C(i2c, 16, 2)
 
             while True:
@@ -137,10 +136,9 @@ def up_button(self):
         .. code-block:: python
 
             import board
-            import busio
             from adafruit_character_lcd.character_lcd_rgb_i2c import Character_LCD_RGB_I2C
 
-            i2c = busio.I2C(board.SCL, board.SDA)
+            i2c = board.I2C()  # uses board.SCL and board.SDA
             lcd = Character_LCD_RGB_I2C(i2c, 16, 2)
 
             while True:
@@ -159,10 +157,9 @@ def down_button(self):
         .. code-block:: python
 
             import board
-            import busio
             from adafruit_character_lcd.character_lcd_rgb_i2c import Character_LCD_RGB_I2C
 
-            i2c = busio.I2C(board.SCL, board.SDA)
+            i2c = board.I2C()  # uses board.SCL and board.SDA
             lcd = Character_LCD_RGB_I2C(i2c, 16, 2)
 
             while True:
@@ -181,10 +178,9 @@ def right_button(self):
         .. code-block:: python
 
             import board
-            import busio
             from adafruit_character_lcd.character_lcd_rgb_i2c import Character_LCD_RGB_I2C
 
-            i2c = busio.I2C(board.SCL, board.SDA)
+            i2c = board.I2C()  # uses board.SCL and board.SDA
             lcd = Character_LCD_RGB_I2C(i2c, 16, 2)
 
             while True:
@@ -203,10 +199,9 @@ def select_button(self):
         .. code-block:: python
 
             import board
-            import busio
             from adafruit_character_lcd.character_lcd_rgb_i2c import Character_LCD_RGB_I2C
 
-            i2c = busio.I2C(board.SCL, board.SDA)
+            i2c = board.I2C()  # uses board.SCL and board.SDA
             lcd = Character_LCD_RGB_I2C(i2c, 16, 2)
 
             while True:

adafruit_character_lcd/character_lcd_spi.py

@@ -15,13 +15,15 @@
 
 **Hardware:**
 
-* `I2C / SPI character LCD backpack <https://www.adafruit.com/product/292>`_
+* `I2C / SPI character LCD backpack
+  <https://www.adafruit.com/product/292>`_ (Product ID: 4566)
 
 **Software and Dependencies:**
 
-* Adafruit CircuitPython firmware:
-  https://github.com/adafruit/circuitpython/releases
-* Adafruit's Bus Device library (when using I2C/SPI):
+* Adafruit CircuitPython firmware for the supported boards:
+  https://circuitpython.org/downloads
+
+* Adafruit's Bus Device library:
   https://github.com/adafruit/Adafruit_CircuitPython_BusDevice
 
 """
@@ -43,11 +45,10 @@ class Character_LCD_SPI(Character_LCD_Mono):  # pylint: disable=too-few-public-m
     .. code-block:: python
 
         import board
-        import busio
         import digitalio
         import adafruit_character_lcd.character_lcd_mono as character_lcd
 
-        spi = busio.SPI(board.SCK, MOSI=board.MOSI)
+        spi = board.SPI()
         latch = digitalio.DigitalInOut(board.D5)
         lcd = character_lcd.Character_LCD_SPI(spi, latch, 16, 2)
     """

docs/index.rst

@@ -23,11 +23,36 @@ Table of Contents
 .. toctree::
     :caption: Tutorials
 
+    Adafruit Light Meter Learning guide <https://learn.adafruit.com/light-meter>
+
+    Adafruit i2c/SPI LCD Backpack Learning Guide <https://learn.adafruit.com/i2c-spi-lcd-backpack>
+
+    Adafruit i2c / SPI character LCD backpack Learning Guide <https://learn.adafruit.com/character-lcds>
+
+    Adafruit RGB LCD Shield Kit w/ 16x2 Character Display Learning Guide <https://learn.adafruit.com/rgb-lcd-shield>
+
+    Adafruit RGB Positive 16x2 LCD+Keypad Kit for Raspberry Pi Learning Guide <https://learn.adafruit.com/adafruit-16x2-character-lcd-plus-keypad-for-raspberry-pi>
+
 .. toctree::
     :caption: Related Products
 
+    Standard LCD 16x2 + extras - white on blue <https://www.adafruit.com/product/181>
+
+    Adafruit Standard LCD 20x4 + extras - white on blue <https://www.adafruit.com/product/198>
+
     Adafruit Character LCDs <http://www.adafruit.com/category/63_96>
 
+    Adafruit i2c / SPI character LCD backpack <https://www.adafruit.com/product/292>
+
+    Adafruit RGB backlight negative LCD 16x2 + extras - RGB on black <https://www.adafruit.com/product/399>
+
+    Adafruit RGB LCD Shield Kit w/ 16x2 Character Display <https://www.adafruit.com/product/716>
+
+    Adafruit RGB Positive 16x2 LCD+Keypad Kit for Raspberry Pi <https://www.adafruit.com/product/1109>
+
+    Adafruit RGB Negative 16x2 LCD+Keypad Kit for Raspberry Pi <https://www.adafruit.com/product/1110>
+
+
 .. toctree::
     :caption: Other Links
 

examples/charlcd_i2c_mono_simpletest.py

@@ -4,15 +4,14 @@
 """Simple test for 16x2 character lcd connected to an MCP23008 I2C LCD backpack."""
 import time
 import board
-import busio
 import adafruit_character_lcd.character_lcd_i2c as character_lcd
 
 # Modify this if you have a different sized Character LCD
 lcd_columns = 16
 lcd_rows = 2
 
 # Initialise I2C bus.
-i2c = busio.I2C(board.SCL, board.SDA)
+i2c = board.I2C()  # uses board.SCL and board.SDA
 
 # Initialise the lcd class
 lcd = character_lcd.Character_LCD_I2C(i2c, lcd_columns, lcd_rows)

examples/charlcd_i2c_rgb_simpletest.py

@@ -4,15 +4,14 @@
 """Simple test for I2C RGB character LCD shield kit"""
 import time
 import board
-import busio
 import adafruit_character_lcd.character_lcd_rgb_i2c as character_lcd
 
 # Modify this if you have a different sized Character LCD
 lcd_columns = 16
 lcd_rows = 2
 
 # Initialise I2C bus.
-i2c = busio.I2C(board.SCL, board.SDA)
+i2c = board.I2C()  # uses board.SCL and board.SDA
 
 # Initialise the LCD class
 lcd = character_lcd.Character_LCD_RGB_I2C(i2c, lcd_columns, lcd_rows)