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
51 Commits 10 Branches 125 Tags
924e866539a9d613d45666ce054e957919ca8d73
Commit Graph
44 Commits
Author SHA1 Message Date
Laurens Valk 924e866539 doc: separate images and labels 
- remove quick draft images
- push plain screenshots and separate plain text svg files
- Update label content based on user feedback
- Cleaner label layout
- Use same fonts in labels as in text + better scaling
- basic automation of inkscape in travis; this probably needs some work. It  should at least be moved into the make doc instead
 2019-02-08 12:54:57 +01:00
Laurens Valk 0f6656ada1 doc: signal types 
fixes #111
 2019-02-07 12:29:42 +01:00
Laurens Valk 7935a4ab57 doc: proposed API update for dc motor settings 2019-02-06 15:48:54 +01:00
David Lechner 050302d6a1 doc: add logo to footer in pdf 2019-01-30 10:43:50 -06:00
Laurens Valk 0125afd45b doc: add image and sound file enums 
fixes #94

bricks/ev3dev: static sound and image file enums
 2019-01-29 11:00:30 +01:00
David Lechner bd94558375 doc: allow branding in title via environment variable 2019-01-25 11:12:04 -06:00
David Lechner 2e392e2312 doc: enable warnings as errors 
This will let CI catch more problems. Fixes #104

Checking references had to be temporarily disabled because of temporarily disabled pages.
 2019-01-24 16:34:24 -06:00
David Lechner d3475f7870 doc: fix module index 
some modules were missing because of missing automodule directive
 2019-01-24 16:10:11 -06:00
David Lechner af6fdf9729 doc: clean up latex/pdf doc 
- Override header and footer
    - fixes warnings about even/odd pages
    - adds disclaimer for LEGO trademarks
- rename "Release" to "Version"
- new title
- remove authors
 2019-01-24 16:09:30 -06:00
Laurens Valk 25f0aa24d8 doc: remove unwritten intro 2019-01-24 16:12:38 +01:00
Laurens Valk ce1ec1cb55 doc: copyediting 2019-01-24 15:52:00 +01:00
David Lechner 2acc07d0d2 doc: update for directory name changes in examples submodule 2019-01-21 20:16:00 -06:00
David Lechner cbefc64136 doc: add some Pybricks branding 
This adds some Pybricks logos to the the generated docs .

The actual logos are quick hacks and should be revisited.
 2019-01-20 19:10:26 -06:00
David Lechner 48d795ea08 doc: add dummy file so we stop getting warnings 
This prevents warnings about the _static directory not existing. We will probably want to override something eventually, so adding an empty file rather than removing it from conf.py.
 2019-01-20 19:02:33 -06:00
Laurens Valk 18652e0639 doc: update robot arm name and references 2019-01-19 18:22:01 +01:00
Laurens Valk 1918adf7b4 doc: remove vscode instructions for first release 
add examples instead

users can use their favorite method of getting the examples or their own scripts to the brick
 2019-01-19 17:31:45 +01:00
Laurens Valk 0a8cb055b2 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
Laurens Valk 072ba814d7 doc: formatting 
.

Remove empty pages

a few images were falling off the page because there wasn't any body text.
 2019-01-18 16:50:07 +01:00
Laurens Valk 188dbf0e7d doc: update ev3dev link 2019-01-17 23:14:33 +01:00
Laurens Valk 98adc2edb1 doc: placeholder run diagrams 2019-01-17 21:05:13 +01:00
Laurens Valk 3b8e9bfda1 doc: very rough installation steps 2019-01-17 19:38:50 +01:00
Laurens Valk 23d5e582e3 doc: extend table of contents 2019-01-17 11:26:13 +01:00
Laurens Valk 8a133b8101 doc: test instructions 2019-01-16 21:29:19 +01:00
David Lechner cccc9f9b46 Merge branch 'travis' 2019-01-15 21:42:00 -06:00
David Lechner a15f3bc99a use versioneer for setting python package version 
https://github.com/warner/python-versioneer

😋 🍪
 2019-01-15 20:58:43 -06:00
Laurens Valk 7867704514 bricks/ev3dev: move print to tools 2019-01-13 18:37:00 +01:00
Laurens Valk 5381f528f5 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 9e65c7eabc extmod: implement run_until_stalled with variable limits 2019-01-12 12:02:39 +01:00
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