Michel2/pybricks-api
1
0
Fork 0
mirror of https://github.com/pybricks/pybricks-api.git synced 2026-09-12 01:24:17 +00:00
Code Issues Releases Activity
6 Commits 10 Branches 125 Tags
a07aaadd2393b86b8de34de8eef8c153f22b66ea
Commit Graph
6 Commits
This Branch
This Branch
All Branches
Author SHA1 Message Date
Laurens Valk a07aaadd23 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 89fc64d911 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 170f5844d4 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 edb507e5c5 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
Laurens Valk 1c59f72407 fake-api: init 2018-12-21 12:45:00 +01:00
David Lechner 76fda14db9 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