Merge pull request #43 from jposada202020/correcting_readthedocs_API

readthedocs_API_improvement
adafruit · May 20, 2021 · 2f625ce · 2f625ce
2 parents 0844e35 + 97b1583
commit 2f625ce
Show file tree

Hide file tree

Showing 9 changed files with 48 additions and 9 deletions.
diff --git a/adafruit_tinylora/adafruit_tinylora.py b/adafruit_tinylora/adafruit_tinylora.py
@@ -3,7 +3,7 @@
 # SPDX-License-Identifier: GPL-3.0-or-later
 
 """
-`Adafruit_TinyLoRa`
+`adafruit_tinylora`
 ====================================================
 CircuitPython LoRaWAN implementation for use with
 The Things Network.

diff --git a/adafruit_tinylora/adafruit_tinylora_encryption.py b/adafruit_tinylora/adafruit_tinylora_encryption.py
@@ -4,7 +4,7 @@
 # SPDX-License-Identifier: MIT
 
 """
-`adafruit_tinylora_encryption.py`
+`adafruit_tinylora_encryption`
 ======================================================
 Required tinyLoRA Encryption Methods for AES and
 Message Integrity checks.

diff --git a/adafruit_tinylora/ttn_as.py b/adafruit_tinylora/ttn_as.py
@@ -3,7 +3,7 @@
 # SPDX-License-Identifier: MIT
 
 """
-`ttn_as.py`
+`ttn_as`
 ======================================================
 AS920 The Things Network Frequency Plans
 * Author(s): Brent Rubell

diff --git a/adafruit_tinylora/ttn_au.py b/adafruit_tinylora/ttn_au.py
@@ -3,7 +3,7 @@
 # SPDX-License-Identifier: MIT
 
 """
-`ttn_au.py`
+`ttn_au`
 ======================================================
 The Things Network Frequency Plans - AU915
 * Author(s): Brent Rubell

diff --git a/adafruit_tinylora/ttn_cn.py b/adafruit_tinylora/ttn_cn.py
@@ -4,7 +4,7 @@
 # SPDX-License-Identifier: MIT
 
 """
-`ttn_cn.py`
+`ttn_cn`
 ======================================================
 The Things Network Frequency Plans - CN470
 * Author(s): IAMLIUBO

diff --git a/adafruit_tinylora/ttn_eu.py b/adafruit_tinylora/ttn_eu.py
@@ -3,7 +3,7 @@
 # SPDX-License-Identifier: MIT
 
 """
-`ttn_eu.py`
+`ttn_eu`
 ======================================================
 The Things Network Frequency Plans - EU863
 * Author(s): Brent Rubell

diff --git a/adafruit_tinylora/ttn_usa.py b/adafruit_tinylora/ttn_usa.py
@@ -3,7 +3,7 @@
 # SPDX-License-Identifier: MIT
 
 """
-`ttn_usa.py`
+`ttn_usa`
 ======================================================
 The Things Network Frequency Plans - US902
 * Author(s): Brent Rubell

diff --git a/docs/api.rst b/docs/api.rst
@@ -4,7 +4,28 @@
 .. If your library file(s) are nested in a directory (e.g. /adafruit_foo/foo.py)
 .. use this format as the module name: "adafruit_foo.foo"
 
-TinyLoRa
-========
 .. automodule:: adafruit_tinylora
    :members:
+   :member-order: bysource
+
+
+.. automodule:: adafruit_tinylora.adafruit_tinylora
+   :members:
+
+.. automodule:: adafruit_tinylora.adafruit_tinylora_encryption
+   :members:
+
+.. automodule:: adafruit_tinylora.ttn_as
+   :members:
+
+.. automodule:: adafruit_tinylora.ttn_au
+   :members:
+
+.. automodule:: adafruit_tinylora.ttn_cn
+   :members:
+
+.. automodule:: adafruit_tinylora.ttn_eu
+   :members:
+
+.. automodule:: adafruit_tinylora.ttn_usa
+   :members:
diff --git a/docs/examples.rst b/docs/examples.rst
@@ -6,3 +6,21 @@ Ensure your device works with this simple test.
 .. literalinclude:: ../examples/tinylora_simpletest.py
     :caption: examples/tinylora_simpletest.py
     :linenos:
+
+Using TinyLora with a Sensor
+----------------------------
+
+Using TinyLoRa with a Si7021 Sensor
+
+.. literalinclude:: ../examples/tinylora_simpletest_si7021.py
+    :caption: examples/tinylora_simpletest_si7021.py
+    :linenos:
+
+Using a single Channel
+----------------------
+
+Ensure your device works with this simple test.
+
+.. literalinclude:: ../examples/tinylora_simpletest_single_channel.py
+    :caption: examples/tinylora_simpletest_single_channel.py
+    :linenos: