diff options
| author | Daniel Thompson <daniel@redfelineninja.org.uk> | 2021-01-13 22:06:26 (GMT) |
|---|---|---|
| committer | Daniel Thompson <daniel@redfelineninja.org.uk> | 2021-01-13 22:06:26 (GMT) |
| commit | 727bc8c685b5f33c76964f49bb933f68dddb7824 (patch) | |
| tree | b35e48cfaa14388151ae8a4e8da0cfc21de1f4e2 /docs | |
| parent | 39d87830558540fefad1d4dd24a14f273bd4d5a7 (diff) | |
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 <daniel@redfelineninja.org.uk>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/apps.rst | 34 | ||||
| -rw-r--r-- | docs/wasp.rst | 41 |
2 files changed, 24 insertions, 51 deletions
diff --git a/docs/apps.rst b/docs/apps.rst index 0cb75ce..d015852 100644 --- a/docs/apps.rst +++ b/docs/apps.rst @@ -6,29 +6,31 @@ Application Library .. contents:: :local: +Watch faces +----------- + +.. automodule:: apps.clock + +.. automodule:: apps.chrono + +.. automodule:: apps.fibonacci_clock + 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`: +.. automodule:: apps.heart - * :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` +.. automodule:: apps.stopwatch -Watch faces ------------ +.. automodule:: apps.steps -.. automodule:: apps.chrono +.. automodule:: apps.launcher -.. automodule:: apps.fibonacci_clock +.. 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 ---------- |