From 727bc8c685b5f33c76964f49bb933f68dddb7824 Mon Sep 17 00:00:00 2001 From: Daniel Thompson Date: Wed, 13 Jan 2021 22:06:26 +0000 Subject: [PATCH] docs: Move all applications out of the reference guide The auto-generated application docs isn't really worthy of the reference guide. There's too many methods described as "draws the screen" and this simply doesn't add anything over the template application includes in the application writer's guide. Move everything over into the Application Library. Signed-off-by: Daniel Thompson --- docs/apps.rst | 36 +++++++++++++++++++----------------- docs/wasp.rst | 41 ++++++----------------------------------- 2 files changed, 25 insertions(+), 52 deletions(-) diff --git a/docs/apps.rst b/docs/apps.rst index 0cb75ce..d015852 100644 --- a/docs/apps.rst +++ b/docs/apps.rst @@ -6,30 +6,32 @@ Application Library .. contents:: :local: -Built-in --------- - -The built-in application are summarised below but because these apps are -treated as examples they are described in detail as part of the -:ref:`Wasp-os Reference Manual`: - - * :py:class:`.ClockApp` - * :py:class:`.HeartApp` - * :py:class:`.LauncherApp` - * :py:class:`.PagerApp` - * :py:class:`.SettingsApp` - * :py:class:`.SoftwareApp` - * :py:class:`.StepCounterApp` - * :py:class:`.StopwatchApp` - * :py:class:`.TemplateApp` - Watch faces ----------- +.. automodule:: apps.clock + .. automodule:: apps.chrono .. automodule:: apps.fibonacci_clock +Built-in +-------- + +.. automodule:: apps.heart + +.. automodule:: apps.stopwatch + +.. automodule:: apps.steps + +.. automodule:: apps.launcher + +.. automodule:: apps.settings + +.. automodule:: apps.software + +.. automodule:: apps.pager + Applications ------------ diff --git a/docs/wasp.rst b/docs/wasp.rst index 73bb1f9..e7c7953 100644 --- a/docs/wasp.rst +++ b/docs/wasp.rst @@ -28,6 +28,12 @@ System .. automodule:: fonts.sans24 :members: +.. automodule:: fonts.sans28 + :members: + +.. automodule:: fonts.sans36 + :members: + .. automodule:: logo :members: :undoc-members: @@ -56,41 +62,6 @@ Device drivers .. automodule:: drivers.vibrator :members: -Applications ------------- - -.. automodule:: apps.clock - :members: - :undoc-members: - -.. automodule:: apps.heart - :members: - :undoc-members: - -.. automodule:: apps.launcher - :members: - :undoc-members: - -.. automodule:: apps.pager - :members: - :undoc-members: - -.. automodule:: apps.settings - :members: - :undoc-members: - -.. automodule:: apps.software - :members: - :undoc-members: - -.. automodule:: apps.steps - :members: - :undoc-members: - -.. automodule:: apps.stopwatch - :members: - :undoc-members: - Bootloader ----------