Daniel Thompson
727bc8c685
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>
2021-01-13 22:06:26 +00:00
Daniel Thompson
f7ef165433
simulator: test_qa: Check that apps are includes in the library
...
Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2021-01-12 22:33:25 +00:00
Daniel Thompson
06f1ed36b0
docs: Add an Application Library chapter
...
Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-11-08 14:28:38 +00:00
Daniel Thompson
7ebc361e58
docs: refman: Add the fibonacci clock to the reference manual
...
Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-11-08 12:41:58 +00:00
Daniel Thompson
e391480b50
wasp: watch: docstrings for the watch namespace
2020-05-14 23:22:57 +01:00
Daniel Thompson
d11e6eb4a1
Make wasp-os namig consistant
...
Rename WASP to wasp-os (or Wasp-os)
2020-05-14 22:41:05 +01:00
Daniel Thompson
b8efcd3053
wasp: Even more docstrings
2020-05-14 22:29:35 +01:00
Daniel Thompson
f07fb6d22a
wasp: draw565: docstrings for headings and __init__
2020-05-14 21:44:05 +01:00
Daniel Thompson
42fe7bf352
drivers: vibrator: Finalize docstrings
2020-05-14 21:42:16 +01:00
Daniel Thompson
95f1788347
drivers: st7789: Finalize docstrings
2020-05-14 21:41:02 +01:00
Daniel Thompson
9274d8cc2d
drivers: signal: Finalize docstrings
2020-05-14 21:39:14 +01:00
Daniel Thompson
880083977c
drivers: nrf_rtc: Finalize docstrings
2020-05-14 21:36:33 +01:00
Daniel Thompson
d5c629a9ac
drivers: cst816s: Finalize docstrings
2020-05-14 21:36:09 +01:00
Daniel Thompson
85079c149b
drivers: battery: Finalize docstrings
2020-05-14 21:32:01 +01:00
Daniel Thompson
a2fd52ef2b
docs: Introduce the Application Writer's Guide.
2020-05-11 21:44:30 +01:00
Daniel Thompson
bb8e95cdd4
docs: Document the bootloader protocols
...
GPREGRET, PNVRAM and WDT protocols are all now fully documented.
2020-05-10 10:43:02 +01:00
Daniel Thompson
683c3497e0
docs: Fix warnings and add a few extra apps to the docs
2020-04-11 20:26:12 +01:00
Daniel Thompson
f8bd1a7461
Rename manager.py and expose its interfaces to all applications
...
This is a big change that break compatiblity with existing applications
*and* with existing installed versions of main.py.
When upgrading it is import to update main.py:
./tools/wasptool --upload wasp/main.py
2020-03-22 12:37:19 +00:00
Daniel Thompson
d2058fb87f
docs: Increase the scope of the documentation
...
We now generate documentation for everything included in the PineTime
manifest (although, at this stage, not everything in the manifest has
all the required docstrings).
2020-03-08 17:40:27 +00:00
Daniel Thompson
799a66c9b9
wasp: Move the apps into their own directory.
2020-03-08 17:39:39 +00:00
Daniel Thompson
27e35527ff
docs: Use sphinx to gather together all the wasp docs
2020-02-22 21:17:30 +00:00