Merge pull request #16 from Neradoc/add-multitrellis-to-docs

Add multitrellis to docs and fix a couple of typos

Author: ladyada

adafruit_neotrellis/multitrellis.py

@@ -3,7 +3,7 @@
 # SPDX-License-Identifier: MIT
 
 """
-interface for connecting together multiple NeoTrellis boards.
+Interface for connecting together multiple NeoTrellis boards.
 """
 
 # imports

docs/api.rst

@@ -6,3 +6,6 @@
 
 .. automodule:: adafruit_neotrellis.neotrellis
    :members:
+
+.. automodule:: adafruit_neotrellis.multitrellis
+   :members:

docs/examples.rst

@@ -6,3 +6,12 @@ Ensure your device works with this simple test.
 .. literalinclude:: ../examples/neotrellis_simpletest.py
     :caption: examples/neotrellis_simpletest.py
     :linenos:
+
+MultiTrellis test
+------------------
+
+The multitrellis submodule helps manage multiple trellis as one.
+
+.. literalinclude:: ../examples/neotrellis_multitrellis_simpletest.py
+    :caption: examples/neotrellis_multitrellis_simpletest.py
+    :linenos:

docs/index.rst

@@ -11,6 +11,7 @@ Table of Contents
 
 .. toctree::
     :caption: Examples
+    :maxdepth: 3
 
     examples
 

examples/neotrellis_multitrellis_simpletest.py

@@ -40,7 +40,7 @@ def blink(xcoord, ycoord, edge):
     # turn the LED on when a rising edge is detected
     if edge == NeoTrellis.EDGE_RISING:
         trellis.color(xcoord, ycoord, BLUE)
-    # turn the LED off when a rising edge is detected
+    # turn the LED off when a falling edge is detected
     elif edge == NeoTrellis.EDGE_FALLING:
         trellis.color(xcoord, ycoord, OFF)
 

examples/neotrellis_simpletest.py

@@ -27,7 +27,7 @@ def blink(event):
     # turn the LED on when a rising edge is detected
     if event.edge == NeoTrellis.EDGE_RISING:
         trellis.pixels[event.number] = CYAN
-    # turn the LED off when a rising edge is detected
+    # turn the LED off when a falling edge is detected
     elif event.edge == NeoTrellis.EDGE_FALLING:
         trellis.pixels[event.number] = OFF