Michel2/pybricks-api
1
0
Fork 0
mirror of https://github.com/pybricks/pybricks-api.git synced 2026-07-28 04:07:46 +00:00
Code Issues Releases Activity
1,322 Commits 10 Branches 124 Tags
4967b96ddd56c3076a3add01ab0ff2e8ba7ab655
Commit Graph
1322 Commits
This Branch
This Branch
All Branches
Author SHA1 Message Date
Laurens Valk d5d7b9a9c7 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 0cdf3fdebc 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 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 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 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 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 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 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
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
Laurens Valk 7e1139f195 doc: use flowchart instead of table 2018-10-20 13:59:24 +02:00
Laurens Valk 044dddfec1 doc: starting point for yable of user actions 2018-10-19 20:42:49 +02:00
Laurens Valk 95a8d12058 design: programming 2018-10-19 14:02:32 +02:00
Laurens Valk aa65ce6b54 formatting: normalize line endings for make.bat 
Unable to discard this locally, testing if committing this fixes it.
See comments on 2163a0eef77cdf95087813a363f056efd7472243
 2018-10-18 11:19:38 +02: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
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
David Lechner d8533cb6bc pbio: split low-level I/O dirvers from high-level library 
The eventual goal here is that the pbdrv functions will be the absolute minimim needed to do the actual I/O to the hardware. Everything else should be implemented in the main library.
 2018-09-07 16:47:36 -05:00
David Lechner dad155641e doc: set doxygen for pbio library 2018-09-06 19:54:07 -05:00
David Lechner 634d5595d0 doc: set up a doc template with a few random items 2018-09-06 16:22:44 -05:00