simulator: test_qa: Check that apps are includes in the library

Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
This commit is contained in:
Daniel Thompson 2021-01-12 22:33:25 +00:00
parent aab718f917
commit f7ef165433
3 changed files with 51 additions and 12 deletions

View file

@ -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,6 +31,23 @@ Watch faces
.. automodule:: apps.fibonacci_clock
Applications
------------
.. automodule:: apps.alarm
.. automodule:: apps.calc
.. automodule:: apps.flashlight
.. automodule:: apps.haiku
.. automodule:: apps.musicplayer
.. automodule:: apps.testapp
.. automodule:: apps.timer
Games
-----
@ -35,12 +56,3 @@ Games
.. automodule:: apps.play2048
.. automodule:: apps.snake
Integration
-----------
.. automodule:: apps.alarm
.. automodule:: apps.musicplayer
.. automodule:: apps.timer

View file

@ -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:

View file

@ -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