pinetime/wasp-os
1
0
Fork 0
Code Activity
wasp-os/docs/wasp.rst

92 lines
1.3 KiB
ReStructuredText
Raw Normal View History

docs: Use sphinx to gather together all the wasp docs
2020-02-22 22:17:30 +01:00
WASP Internals
==============
System management
-----------------
Rename manager.py and expose its interfaces to all applications This is a big change that break compatiblity with existing applications *and* with existing installed versions of main.py. When upgrading it is import to update main.py: ./tools/wasptool --upload wasp/main.py
2020-03-22 13:37:19 +01:00
.. automodule:: wasp
docs: Use sphinx to gather together all the wasp docs
2020-02-22 22:17:30 +01:00
:members:
:undoc-members:
Applications
------------
wasp: Move the apps into their own directory.
2020-03-08 18:37:43 +01:00
.. automodule:: apps.clock
docs: Use sphinx to gather together all the wasp docs
2020-02-22 22:17:30 +01:00
:members:
:undoc-members:
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).
2020-03-08 18:40:27 +01:00
.. automodule:: apps.flashlight
:members:
:undoc-members:
docs: Fix warnings and add a few extra apps to the docs
2020-04-11 21:26:12 +02:00
.. automodule:: apps.launcher
:members:
:undoc-members:
.. automodule:: apps.pager
:members:
:undoc-members:
.. automodule:: apps.template
:members:
:undoc-members:
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).
2020-03-08 18:40:27 +01:00
.. automodule:: apps.testapp
:members:
:undoc-members:
docs: Use sphinx to gather together all the wasp docs
2020-02-22 22:17:30 +01:00
Device drivers
--------------
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).
2020-03-08 18:40:27 +01:00
.. 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:
docs: Use sphinx to gather together all the wasp docs
2020-02-22 22:17:30 +01:00
.. automodule:: drivers.st7789
:members:
:undoc-members:
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).
2020-03-08 18:40:27 +01:00
.. automodule:: drivers.vibrator
:members:
:undoc-members:
docs: Use sphinx to gather together all the wasp docs
2020-02-22 22:17:30 +01:00
Libraries
---------
.. automodule:: draw565
:members:
:undoc-members:
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).
2020-03-08 18:40:27 +01:00
.. 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:
Copy permalink