diff options
| author | Daniel Thompson <daniel@redfelineninja.org.uk> | 2021-01-12 22:33:25 (GMT) |
|---|---|---|
| committer | Daniel Thompson <daniel@redfelineninja.org.uk> | 2021-01-12 22:33:25 (GMT) |
| commit | f7ef1654339b05989f0cdfc9ff5ab78ca03300b6 (patch) | |
| tree | bf9dbc88c29b6267e490ab26df8e367cd9397962 | |
| parent | aab718f917b908c8c756952ae069e01108312e91 (diff) | |
simulator: test_qa: Check that apps are includes in the library
Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
| -rw-r--r-- | docs/apps.rst | 32 | ||||
| -rw-r--r-- | docs/wasp.rst | 16 | ||||
| -rw-r--r-- | wasp/boards/simulator/test_qa.py | 15 |
3 files changed, 51 insertions, 12 deletions
diff --git a/docs/apps.rst b/docs/apps.rst index 38f3617..37bc795 100644 --- a/docs/apps.rst +++ b/docs/apps.rst @@ -14,9 +14,13 @@ treated as examples they are described in detail as part of the :ref:`Wasp-os Reference Manual`: * :py:class:`.ClockApp` - * :py:class:`.FlashlightApp` + * :py:class:`.HeartApp` * :py:class:`.LauncherApp` * :py:class:`.PagerApp` + * :py:class:`.SettingsApp` + * :py:class:`.SoftwareApp` + * :py:class:`.StepCounterApp` + * :py:class:`.StopwatchApp` * :py:class:`.TestApp` * :py:class:`.TemplateApp`` @@ -27,20 +31,28 @@ Watch faces .. automodule:: apps.fibonacci_clock -Games ------ +Applications +------------ -.. automodule:: apps.gameoflife - -.. automodule:: apps.play2048 +.. automodule:: apps.alarm -.. automodule:: apps.snake +.. automodule:: apps.calc -Integration ------------ +.. automodule:: apps.flashlight -.. automodule:: apps.alarm +.. automodule:: apps.haiku .. automodule:: apps.musicplayer +.. automodule:: apps.testapp + .. automodule:: apps.timer + +Games +----- + +.. automodule:: apps.gameoflife + +.. automodule:: apps.play2048 + +.. automodule:: apps.snake diff --git a/docs/wasp.rst b/docs/wasp.rst index 6ec18ef..73bb1f9 100644 --- a/docs/wasp.rst +++ b/docs/wasp.rst @@ -63,7 +63,7 @@ Applications :members: :undoc-members: -.. automodule:: apps.flashlight +.. automodule:: apps.heart :members: :undoc-members: @@ -75,7 +75,19 @@ Applications :members: :undoc-members: -.. automodule:: apps.testapp +.. automodule:: apps.settings + :members: + :undoc-members: + +.. automodule:: apps.software + :members: + :undoc-members: + +.. automodule:: apps.steps + :members: + :undoc-members: + +.. automodule:: apps.stopwatch :members: :undoc-members: diff --git a/wasp/boards/simulator/test_qa.py b/wasp/boards/simulator/test_qa.py index 206e505..0bde20b 100644 --- a/wasp/boards/simulator/test_qa.py +++ b/wasp/boards/simulator/test_qa.py @@ -18,3 +18,18 @@ def test_screenshot_README(constructor): with open('README.rst') as f: readme = f.read() assert fname in readme + +def test_apps_documented(constructor): + if constructor.NAME in EXCLUDE: + return + + with open('docs/apps.rst') as f: + appdoc = f.read() + with open('docs/wasp.rst') as f: + waspdoc = f.read() + + needle = f'.. automodule:: {constructor.__module__}' + assert needle in appdoc or needle in waspdoc + + if needle in waspdoc: + assert constructor.__name__ in appdoc |