summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Thompson <daniel@redfelineninja.org.uk>2020-03-08 17:40:27 (GMT)
committerDaniel Thompson <daniel@redfelineninja.org.uk>2020-03-08 17:40:27 (GMT)
commitd2058fb87f98c9c12e78a23baada8a407519d1de (patch)
tree8c594e8654634b6d2912e1759091684c0c82ce43
parent799a66c9b95a1f95eba8b3412c45b6290ec68a73 (diff)
docs: Increase the scope of the documentation
We now generate documentation for everything included in the PineTime manifest (although, at this stage, not everything in the manifest has all the required docstrings).
-rw-r--r--docs/wasp.rst49
-rw-r--r--wasp/boards/sphinx/machine.py8
2 files changed, 57 insertions, 0 deletions
diff --git a/docs/wasp.rst b/docs/wasp.rst
index bd6e8a3..039e819 100644
--- a/docs/wasp.rst
+++ b/docs/wasp.rst
@@ -15,16 +15,65 @@ Applications
:members:
:undoc-members:
+.. automodule:: apps.flashlight
+ :members:
+ :undoc-members:
+
+.. automodule:: apps.testapp
+ :members:
+ :undoc-members:
+
Device drivers
--------------
+.. automodule:: drivers.battery
+ :members:
+ :undoc-members:
+
+.. automodule:: drivers.cst816s
+ :members:
+ :undoc-members:
+
+.. automodule:: drivers.nrf_rtc
+ :members:
+ :undoc-members:
+
+.. automodule:: drivers.signal
+ :members:
+ :undoc-members:
+
.. automodule:: drivers.st7789
:members:
:undoc-members:
+.. automodule:: drivers.vibrator
+ :members:
+ :undoc-members:
+
Libraries
---------
.. automodule:: draw565
:members:
:undoc-members:
+
+.. automodule:: icons
+ :members:
+ :undoc-members:
+
+.. automodule:: fonts.clock
+ :members:
+ :undoc-members:
+
+.. automodule:: fonts.sans24
+ :members:
+ :undoc-members:
+
+.. automodule:: logo
+ :members:
+ :undoc-members:
+
+.. automodule:: widgets
+ :members:
+ :undoc-members:
+
diff --git a/wasp/boards/sphinx/machine.py b/wasp/boards/sphinx/machine.py
index e69de29..b35a2a7 100644
--- a/wasp/boards/sphinx/machine.py
+++ b/wasp/boards/sphinx/machine.py
@@ -0,0 +1,8 @@
+class ADC():
+ pass
+
+class Pin():
+ pass
+
+class PWM():
+ pass