diff options
| author | Daniel Thompson <daniel@redfelineninja.org.uk> | 2020-11-08 14:28:38 (GMT) |
|---|---|---|
| committer | Daniel Thompson <daniel@redfelineninja.org.uk> | 2020-11-08 14:28:38 (GMT) |
| commit | 06f1ed36b0996ccf48daff3e4bf2a55f308128d7 (patch) | |
| tree | 9a1a564c24833c3b23f0a653e2f0e1f4aceb5ac0 /docs | |
| parent | 7015dc0023714078955fcffeeb1b095a4245f79f (diff) | |
docs: Add an Application Library chapter
Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/apps.rst | 39 | ||||
| -rw-r--r-- | docs/index.rst | 1 | ||||
| -rw-r--r-- | docs/wasp.rst | 3 |
3 files changed, 40 insertions, 3 deletions
diff --git a/docs/apps.rst b/docs/apps.rst new file mode 100644 index 0000000..7b24401 --- /dev/null +++ b/docs/apps.rst @@ -0,0 +1,39 @@ +.. _Application Library: + +Application Library +=================== + +.. contents:: + :local: + +Built-in +-------- + +The built-in application are summarised below but since these apps are +considers to be examples they are described in detail as part of the +:ref:`Wasp-os Reference Manual`: + + * :py:class:`.ClockApp` + * :py:class:`.FlashlightApp` + * :py:class:`.LauncherApp` + * :py:class:`.PagerApp` + * :py:class:`.TestApp` + * :py:class:`.TemplateApp`` + +Watch faces +----------- + +.. automodule:: apps.fibonacci_clock + +This is enabled by default in the simulator. The app is bundled in the +firmware image but it is disabled by default to keep RAM available for +user developed applications. It can be enabled by modifying ``main.py``. + +Games +----- + +.. automodule:: apps.gameoflife + +This is enabled by default in the simulator. The app is bundled in the +firmware image but it is disabled by default to keep RAM available for +user developed applications. It can be enabled by modifying ``main.py``. diff --git a/docs/index.rst b/docs/index.rst index 8f38273..75c4bc1 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -12,6 +12,7 @@ Welcome to WASP-OS's documentation! README install + apps appguide wasp contributing diff --git a/docs/wasp.rst b/docs/wasp.rst index 34a3d9e..6ec18ef 100644 --- a/docs/wasp.rst +++ b/docs/wasp.rst @@ -63,9 +63,6 @@ Applications :members: :undoc-members: -.. automodule:: apps.fibonacci_clock - :members: - .. automodule:: apps.flashlight :members: :undoc-members: |