Commit Graph
28 Commits
Author SHA1 Message Date
Laurens Valk daa213b003 doc: drop features that won't be implemented for first release
Combined with previous comments, this closes #91
2019-01-18 17:19:19 +01:00
David Lechner de8d91df4b Merge branch 'travis' 2019-01-15 21:42:00 -06:00
David Lechner 237addb39c fake-pybricks/setup.py: update python_requires to PEP 440
Use the PEP 440 depenency format. The `>` character was breaking the package manager on jfrog.

Picked 3.4 since that is what micropython is based on.
2019-01-15 21:29:36 -06:00
David Lechner e0b08cfad9 use versioneer for setting python package version
https://github.com/warner/python-versioneer

😋 🍪
2019-01-15 20:58:43 -06:00
David Lechner 53e386e3cf fake-pybricks: rename python package to fake-pybricks
temporary workaround for issue #92
2019-01-15 16:40:56 -06:00
Laurens Valk fea24b6431 bricks/ev3dev: move print to tools 2019-01-13 18:37:00 +01:00
Laurens Valk b8b206db38 extmod: Make light function and doc match
For now, do not implement features such as brightness and patterns.
2019-01-13 18:10:22 +01:00
Laurens Valk 069f59a13a modmotor: make dc match docs
This adds an optional argument to limit the duty cycle
2019-01-13 17:51:55 +01:00
Laurens Valk 4ad8c8ac9c extmod: implement run_until_stalled with variable limits 2019-01-12 12:02:39 +01:00
Laurens Valk 34bc88dae3 doc: group motor methods by rubric 2019-01-11 09:03:18 +01:00
Laurens Valk 1cb21098a5 doc: motor debug, dc, and tracking api 2019-01-10 10:31:26 +01:00
Laurens Valk b6c302321a doc: simplify motor settings 2019-01-09 16:08:32 +01:00
Laurens Valk e9d83c80c4 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 9164414b78 doc: wait is last argument 2019-01-06 16:40:18 +01:00
Laurens Valk 15791fbe8d doc: brick, sound, display, and experiment with samples 2019-01-04 15:05:17 +01:00
Laurens Valk 50525a26bb doc: rough draft EV3 brick 2019-01-03 19:44:10 +01:00
Laurens Valk 803ec9421e doc: tools
need to test StopWatch after this modification
2019-01-03 19:06:04 +01:00
Laurens Valk 98cf320246 doc: simplify gear ratio 2019-01-03 14:10:24 +01:00
Laurens Valk c9c8736d15 doc: motor draft 2019-01-03 13:54:47 +01:00
Laurens Valk bac9dbe86a doc: some organization and toc 2018-12-31 12:54:04 +01:00
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 0cdf3fdebc doc: experiment with signal types 2018-12-29 13:02:59 +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 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