Merge pull request #77 from Neradoc/fix-missing-docs

Add missing submodules to the docs

Author: tannewt

adafruit_featherwing/ina219_featherwing.py

@@ -8,6 +8,9 @@
 
 Helper for using the `INA219 FeatherWing <https://www.adafruit.com/product/3650>`_.
 
+.. image :: ../docs/_static/ina219_featherwing/ina219_featherwing.jpg
+  :alt: INA219 Featherwing
+
 * Author(s): Kattni Rembor
 """
 
@@ -39,9 +42,6 @@ def __init__(self, i2c: Optional[I2C] = None):
     def bus_voltage(self):
         """Bus voltage returns volts.
 
-        .. image :: ../docs/_static/ina219_featherwing/ina219_featherwing.jpg
-          :alt: INA219 Featherwing
-
         This example prints the bus voltage with the appropriate units.
 
         .. code-block:: python
@@ -62,9 +62,6 @@ def bus_voltage(self):
     def shunt_voltage(self):
         """Shunt voltage returns volts.
 
-        .. image :: ../docs/_static/ina219_featherwing/ina219_featherwing.jpg
-          :alt: INA219 Featherwing
-
         This example prints the shunt voltage with the appropriate units.
 
         .. code-block:: python
@@ -85,9 +82,6 @@ def shunt_voltage(self):
     def voltage(self):
         """Voltage, known as load voltage, is bus voltage plus shunt voltage. Returns volts.
 
-        .. image :: ../docs/_static/ina219_featherwing/ina219_featherwing.jpg
-          :alt: INA219 Featherwing
-
         This example prints the voltage with the appropriate units.
 
         .. code-block:: python
@@ -109,9 +103,6 @@ def voltage(self):
     def current(self):
         """Current returns mA.
 
-        .. image :: ../docs/_static/ina219_featherwing/ina219_featherwing.jpg
-          :alt: INA219 Featherwing
-
         This example prints the current with the appropriate units.
 
         .. code-block:: python

adafruit_featherwing/joy_featherwing.py

@@ -173,9 +173,6 @@ def _check_button(self, button: int) -> bool:
     def joystick_offset(self):
         """Offset used to correctly report (0, 0) when the joystick is centered.
 
-        .. image :: ../docs/_static/joy_featherwing/joy_featherwing_joystick.jpg
-          :alt: Joy FeatherWing Joystick
-
         Provide a tuple of (x, y) to set your joystick center to (0, 0).
         The offset you provide is subtracted from the current reading.
         For example, if your joystick reads as (-4, 0), you would enter
@@ -215,9 +212,6 @@ def zero_joystick(self):
         Note: You must not be touching the joystick at the time of zeroing
         for it to be accurate.
 
-        .. image :: ../docs/_static/joy_featherwing/joy_featherwing_joystick.jpg
-          :alt: Joy FeatherWing Joystick
-
         This example zeros the joystick, and prints the coordinates of
         joystick when it is moved.
 

adafruit_featherwing/keyboard_featherwing.py

@@ -6,7 +6,7 @@
 `adafruit_featherwing.keyboard_featherwing`
 ====================================================
 
-Helper for using the `Keyboard Featherwing`
+Helper for using the `Keyboard Featherwing
 <https://www.tindie.com/products/arturo182/keyboard-featherwing-qwerty-keyboard-26-lcd/>`_.
 
 * Author(s): Foamyguy
@@ -38,9 +38,8 @@
 
 
 class KeyboardFeatherwing(TFTFeatherWing):
-    """Class representing a `Keyboard Featherwing`
+    """Class representing a `Keyboard Featherwing
     <https://www.tindie.com/products/arturo182/keyboard-featherwing-qwerty-keyboard-26-lcd/>`_.
-
     """
 
     def __init__(
@@ -64,4 +63,6 @@ def __init__(
             self._display_bus, width=320, height=240
         )
         self.neopixel = neopixel.NeoPixel(neopixel_pin, 1)
+        """Status NeoPixel."""
         self.keyboard = BBQ10Keyboard(i2c)
+        """BBQ10Keyboard instance."""

adafruit_featherwing/led_segments.py

@@ -6,7 +6,7 @@
 `adafruit_featherwing.led_segments`
 ====================================================
 
-Base Class for the AlphaNumeric FeatherWing and 7-Segment FeatherWing helpers_.
+Base Class for the AlphaNumeric FeatherWing and 7-Segment FeatherWing helpers.
 
 * Author(s): Melissa LeBlanc-Williams
 """
@@ -23,10 +23,7 @@
 
 
 class Segments:
-    """Class representing an `Adafruit 14-segment AlphaNumeric FeatherWing
-    <https://www.adafruit.com/product/3139>`_.
-
-    Automatically uses the feather's I2C bus."""
+    """Base Class for the AlphaNumeric FeatherWing and 7-Segment FeatherWing helpers."""
 
     def __init__(self):
         self._segments = None

adafruit_featherwing/tft_featherwing.py

@@ -33,10 +33,7 @@
 
 # pylint: disable-msg=too-few-public-methods, too-many-arguments
 class TFTFeatherWing:
-    """Class representing an `TFT FeatherWing 2.4
-    <https://www.adafruit.com/product/3315>`_.
-
-    """
+    """Base class for TFT FeatherWings."""
 
     def __init__(
         self,
@@ -71,6 +68,8 @@ def __init__(
         except OSError as error:
             print("No SD card found:", error)
 
+        self.touchscreen = None
+        """Controller for the resistive touchscreen."""
         try:
             # the screen might not be ready from cold boot
             time.sleep(0.8)

adafruit_featherwing/tft_featherwing_24.py

@@ -7,7 +7,7 @@
 `adafruit_featherwing.tft_featherwing_24`
 ====================================================
 
-Helper for using the `TFT FeatherWing 2.4"`
+Helper for using the `TFT FeatherWing 2.4"
 <https://www.adafruit.com/product/3315>`_.
 
 * Author(s): Melissa LeBlanc-Williams, Foamyguy
@@ -35,7 +35,7 @@
 class TFTFeatherWing24(TFTFeatherWing):
     """Class representing an `TFT FeatherWing 2.4
     <https://www.adafruit.com/product/3315>`_.
-
+    Attempts to mount the SD card to /sd.
     """
 
     def __init__(
@@ -50,3 +50,4 @@ def __init__(
         self.display = adafruit_ili9341.ILI9341(
             self._display_bus, width=320, height=240
         )
+        """Display object for the FeatherWing's screen."""

adafruit_featherwing/tft_featherwing_35.py

@@ -7,7 +7,7 @@
 `adafruit_featherwing.tft_featherwing_35`
 ====================================================
 
-Helper for using the `TFT FeatherWing 3.5"`
+Helper for using the `TFT FeatherWing 3.5"
 <https://www.adafruit.com/product/3651>`_.
 
 * Author(s): Melissa LeBlanc-Williams, Foamyguy
@@ -33,9 +33,9 @@
 
 # pylint: disable-msg=too-few-public-methods, too-many-arguments
 class TFTFeatherWing35(TFTFeatherWing):
-    """Class representing an `TFT FeatherWing 3.5
+    """Class representing a `TFT FeatherWing 3.5
     <https://www.adafruit.com/product/3651>`_.
-
+    Attempts to mount the SD card to /sd.
     """
 
     def __init__(
@@ -48,3 +48,4 @@ def __init__(
     ):
         super().__init__(spi, cs, dc, ts_cs, sd_cs)
         self.display = HX8357(self._display_bus, width=480, height=320)
+        """Display object for the FeatherWing's screen."""

docs/api.rst

@@ -1,32 +1,51 @@
 
 .. If you created a package, create one automodule per module in the package.
 
+.. automodule:: adafruit_featherwing.alphanum_featherwing
+    :inherited-members:
+    :members:
+
+.. automodule:: adafruit_featherwing.dotstar_featherwing
+    :inherited-members:
+    :members:
+
+.. automodule:: adafruit_featherwing.gps_featherwing
+    :members:
+
 .. automodule:: adafruit_featherwing.ina219_featherwing
-   :members:
+    :members:
 
 .. automodule:: adafruit_featherwing.joy_featherwing
-   :members:
+    :members:
 
-.. automodule:: adafruit_featherwing.alphanum_featherwing
-   :members:
+.. automodule:: adafruit_featherwing.keyboard_featherwing
+    :inherited-members:
+    :members:
 
-.. automodule:: adafruit_featherwing.dotstar_featherwing
-   :members:
+.. automodule:: adafruit_featherwing.matrix_featherwing
+    :members:
+
+.. automodule:: adafruit_featherwing.minitft_featherwing
+    :members:
 
 .. automodule:: adafruit_featherwing.neopixel_featherwing
-   :members:
+    :inherited-members:
+    :members:
 
 .. automodule:: adafruit_featherwing.rtc_featherwing
-   :members:
+    :members:
 
-.. automodule:: adafruit_featherwing.gps_featherwing
-   :members:
+.. automodule:: adafruit_featherwing.sevensegment_featherwing
+    :inherited-members:
+    :members:
 
-.. automodule:: adafruit_featherwing.matrix_featherwing
-   :members:
+.. automodule:: adafruit_featherwing.tempmotion_featherwing
+    :members:
 
-.. automodule:: adafruit_featherwing.minitft_featherwing
-  :members:
+.. automodule:: adafruit_featherwing.tft_featherwing_24
+    :inherited-members:
+    :members:
 
-.. automodule:: adafruit_featherwing.tempmotion_featherwing
-  :members:
+.. automodule:: adafruit_featherwing.tft_featherwing_35
+    :inherited-members:
+    :members:

docs/conf.py

@@ -23,7 +23,13 @@
 # Uncomment the below if you use native CircuitPython modules such as
 # digitalio, micropython and busio. List the modules you use. Without it, the
 # autodoc module docs will fail to generate with a warning.
-autodoc_mock_imports = ["board", "busio"]
+autodoc_mock_imports = [
+    "board",
+    "busio",
+    "bbq10keyboard",
+    "sdcardio",
+    "storage",
+]
 
 intersphinx_mapping = {
     "python": ("https://docs.python.org/3", None),