Commit Graph
16 Commits
Author SHA1 Message Date
Laurens Valk 4c74eff39f doc: group motor methods by rubric 2019-01-11 09:03:18 +01:00
Laurens Valk 5327611ac0 doc: motor debug, dc, and tracking api 2019-01-10 10:31:26 +01:00
Laurens Valk 39eab3230e doc: back to explicit ev3brick and ev3devices
(instead of brick and devices)

After internal discussion:
- This way we need to maintain only one fake API.
- Autocomplete can pick up the right brick/devices.
- Explicit is better than implicit.
2019-01-09 14:51:41 +01:00
Laurens Valk 2f0d7ec0a2 doc: brick, sound, display, and experiment with samples 2019-01-04 15:05:17 +01:00
Laurens Valk 3da8785995 doc: rough draft EV3 brick 2019-01-03 19:44:10 +01:00
Laurens Valk 02bee5766f doc: tools
need to test StopWatch after this modification
2019-01-03 19:06:04 +01:00
Laurens Valk 3873a20497 doc: motor draft 2019-01-03 13:54:47 +01:00
Laurens Valk c5288d34ac doc: some organization and toc 2018-12-31 12:54:04 +01:00
Laurens Valk 56364997a2 doc: motor settings and most ev3 sensors
Note: the motor code will be updated accordingly once updated API is considered final.
2018-12-31 12:15:09 +01:00
Laurens Valk 7c106e2444 doc: experiment with signal types 2018-12-29 13:02:59 +01:00
Laurens Valk 26f0ee02ea doc: hide enum numbers, document members instead
We should not encourage users to use the numerical values (i.e. 2 for Stop.hold or 65 for Port.A)

This also keeps the door open for using qstrings for some enums (Color, Button).
2018-12-28 18:00:02 +01:00
Laurens Valk d5dedc7924 doc: autodoc for init
test syntax for autolinking to types
test syntax to avoid evaluating enum arguments to numbers
2018-12-28 16:40:01 +01:00
Laurens Valk e94b54c380 doc: experiment with tables and ascii art
Sphinx and read the docs seem to require RST. This works well for this sample code.

Unfortunately, vscode code preview seems to require markdown (For the tables. Other RST seems to work.)
2018-12-21 21:31:40 +01:00
Laurens Valk fe82313bde fake-api: parameters module (experimental)
Fix EV3 colors after recent pbio update

And make sphinx compile (but not much more)
2018-12-21 17:44:43 +01:00
David Lechner 54baebc1f5 doc: experimenting with autodoc generation
Observations:

* Type annotations tend to be verbose, for example:

        blink(color1: typing.Union[pblight.Color, pblight.RGB, NoneType], color2: typing.Union[pblight.Color, pblight.RGB, NoneType], pattern: pblight.Pattern) → None

* There seems to be a bug with .. autodata::
2018-09-07 20:53:03 -05:00
David Lechner e44d08a0f0 doc: relocate doc build files 2018-09-07 17:29:41 -05:00