Commit Graph
186 Commits
Author SHA1 Message Date
Laurens Valk 28a5329bb6 api/doc: pybricks is a package 2019-06-05 12:47:24 +02:00
Laurens Valk 727507d66d API: add light instance to ColorDistanceSensor
This is an experimental method for adding lights to some sensors.

And add workaround to make it show up correctly in the docs.

Also some doc8 formatting
2019-06-05 11:49:46 +02:00
Laurens Valk 8d37450fac api: flake8 2019-06-04 15:45:36 +02:00
Laurens Valk 0d3b682223 doc: doc8 2019-06-04 14:47:52 +02:00
Laurens Valk c54241f076 rename hub4 to cityhub 2019-06-03 15:26:50 +02:00
Laurens Valk 92e3735d63 drop class method identifier from docs
For example, this changes

classmethod sound.beeps(number)
   Description

into

sound.beeps(number)
   Description
2019-06-03 15:22:57 +02:00
Laurens Valk f3c29971de api: lights on hubs are instances of generic class 2019-06-03 15:18:26 +02:00
Laurens Valk c43d296511 doc: move snippets to doc
Example snippets are platform specific.
2019-06-03 12:02:16 +02:00
David Lechner 1bf2751daf travis: add new travis CI config 2019-05-09 12:21:17 -05:00
David Lechner 125732238c setup: add options for linters 2019-05-09 12:21:17 -05:00
David Lechner 9ad550dfcb vscode: add settings are extension recommendations
this will help users get a dev environment setup more easliy
2019-05-09 12:21:17 -05:00
David Lechner 4eecb284a8 Pipenv: use pipen for depedencies
This will help ensure that everyone is working from the same version of sphinx, etc.
2019-05-09 12:21:17 -05:00
David Lechner c0b266cd73 git: update .gitattributes for managing line endings
this is so that Windows users don't have problems with line endings when they check out the repo
2019-05-09 11:43:27 -05:00
David Lechner 668b7a43a9 doc: fix include path for api
fix breakage causes by 3091489843
2019-05-09 11:38:42 -05:00
Laurens Valk 3091489843 move API 2019-05-09 17:15:52 +02:00
Laurens Valk 1371d7fb82 move LICENSE
This applies to the docs and the api
2019-05-09 14:59:25 +02:00
Laurens Valk 3a42c8f870 Update config paths
This makes the docs build again:
cd doc
make SOURCEDIR=ev3dev html
make SOURCEDIR=lpf2 html
2019-05-09 14:40:05 +02:00
Laurens Valk c916485666 Add .gitignore 2019-05-09 14:39:28 +02:00
Laurens Valk b8458cd086 add example submodule 2019-05-09 14:27:04 +02:00
Laurens Valk c950bf1d8e import api documentation 2019-05-09 13:23:26 +02:00
Laurens Valk c10b3b9eea import api 2019-05-09 13:19:32 +02:00
Laurens Valk bc42a73f3b Initial commit 2019-05-09 13:14:57 +02:00
Laurens Valk 1972188679 Update copyright dates 2019-05-07 21:50:52 +02:00
Laurens Valk 1e469501b1 doc: windows build script update (untested) 2019-04-20 12:22:15 +02:00
Laurens Valk 3ffa8a4526 doc: initial content for hubs
This is cherry-picking from 86e9b0b0fc15b019406bee43718fbdf3416dcf0d
2019-04-20 11:51:03 +02:00
Laurens Valk 660bc0cea5 doc: initial content for hubs
This is cherry-picking from 86e9b0b0fc15b019406bee43718fbdf3416dcf0d
2019-04-20 11:51:03 +02:00
Laurens Valk 3bf2704466 doc: add lpf2 ColorDistanceSensor
Manually cherry-pick 925b6bc2474e8aa3b8d5c0d56029627f73edf029
2019-04-20 11:24:03 +02:00
Laurens Valk 33b4ef79cc doc: add lpf2 ColorDistanceSensor
Manually cherry-pick 925b6bc2474e8aa3b8d5c0d56029627f73edf029
2019-04-20 11:24:03 +02:00
Laurens Valk e4063ef49c doc: share motor doc between platforms 2019-04-20 10:53:01 +02:00
Laurens Valk b359c3c530 doc: share motor doc between platforms 2019-04-20 10:53:01 +02:00
Laurens Valk c4b11fdb77 doc: placeholder lpf2docs 2019-04-19 17:50:09 +02:00
Laurens Valk 6278f2410d doc: Separate common settings 2019-04-19 16:45:12 +02:00
Anton beb98492a5 doc: fix typo in drive_time example 2019-04-08 12:07:04 +02:00
David Lechner 2e2e5d76b5 ev3dev: make gyro calibrate method private
This method is a bit buggy, so make it private until we get the kinks worked out
2019-03-25 15:48:24 -05:00
Laurens Valk f4fbd805f6 bricks/ev3dev: use dedicated reflection mode
REF-RAW was giving too much variation
2019-03-25 14:13:02 +01:00
Laurens Valk 1a4cdfaf50 doc: add instructions for opening existing project 2019-03-21 15:54:22 +01:00
Laurens Valk ccea3aa937 modmotor: make reset_angle argument explicit
instead of defaulting to 0
2019-03-21 14:19:36 +01:00
Laurens Valk 7165d69517 doc: add figure caption top margin
also rename Fig. to Figure and add colon between Figure and the text:

(Figure X : Something) instead of (Fig. X Something)

Still one space to many, but better than no colon or margin at all

fixes #121
2019-03-01 16:51:46 +01:00
Laurens Valk 4e9e26753a doc: add figure numbers and reference labels
fixes #131
2019-03-01 15:00:36 +01:00
Laurens Valk 5f12f8df0b doc: add battery
Fixes #114

- reorganize common classes in fake API such as Display, Speaker and Battery.
- This does not change the user API
2019-03-01 14:25:56 +01:00
Laurens Valk 0cc04f40b8 doc: add battery
Fixes #114

- reorganize common classes in fake API such as Display, Speaker and Battery.
- This does not change the user API
2019-03-01 14:25:56 +01:00
Laurens Valk d0fa20a89c doc: nomenclature and registered signs 2019-02-28 17:50:26 +01:00
Laurens Valk 5dde48cc57 doc: nomenclature and registered signs 2019-02-28 17:50:26 +01:00
Laurens Valk a1e43998f4 doc: languages and terminology 2019-02-28 17:48:14 +01:00
Laurens Valk 3a632dcd57 doc: languages and terminology 2019-02-28 17:48:14 +01:00
Laurens Valk eef65cb3eb Merge pull request #125 from pybricks/enum
Enum
2019-02-28 12:09:14 +01:00
Laurens Valk 7b6b2d6916 parameters: revert CCW change
This reverts b560a545874271ee5f1de2b8f2c42456b06e2aa2

and adds uppercasing
2019-02-28 11:34:04 +01:00
David Lechner 096e25b892 doc: custom branding is no longer required
Removed all of the envronment variable getting. All values that are used only once are no longer assigned to constant.
2019-02-27 17:25:25 -06:00
David Lechner a42ae1d432 doc: enable external link styling on html output 2019-02-27 17:10:06 -06:00
David Lechner 2bea76d136 doc: add disclaimer to html doc output 2019-02-27 17:10:06 -06:00