Michel2/pybricks-api
1
0
Fork 0
mirror of https://github.com/pybricks/pybricks-api.git synced 2026-09-11 17:14:41 +00:00
Code Issues Releases Activity
773 Commits 10 Branches 125 Tags
2aadc75f2cb786fd0970ecbdb29a1c82492dcc7a
Commit Graph
773 Commits
This Branch
This Branch
All Branches
Author SHA1 Message Date
David Lechner 2aadc75f2c poetry: bump version to match current firmware v3.0.0a5 2021-04-20 12:07:36 -05:00
David Lechner 8bf42c7d2d poetry: Bump RTD and theme versions. 
This is mainly to pull in the requirement of docutils < 0.17 from
sphinx-rtd-theme. Just bumping to latest sphinx doc while we are at it.

Issue: https://github.com/pybricks/pybricks-api/issues/55
 2021-04-12 11:12:23 +02:00
Laurens Valk de13c01673 api/nxtdevices: Update color method. 
This shares the implementation with the PUP color sensors, so update accordingly.
 2021-04-10 15:31:29 +02:00
Laurens Valk ca96ee2fce examples: Update detectable colors API. 2021-04-10 15:31:28 +02:00
Laurens Valk 68f626f1ef doc/pupdevices: Update usage of color. 2021-04-10 15:31:28 +02:00
Laurens Valk 570fac30c5 api/parameters/Color: Fix color definitions. 
Match the implementation.
 2021-04-10 15:31:28 +02:00
Laurens Valk 1f0be98649 api/parameters/Color: Add missing color typing. 2021-04-10 15:31:27 +02:00
Laurens Valk e91590feec examples/pup/sensor: Fix use of lights.on. 
The documentation says to use a list or tuple of brightness values.

https://github.com/pybricks/support/issues/273

Implementation fixed via https://github.com/pybricks/pybricks-micropython/commit/28b5413c2b41283a5c1ea3e8cccf4a2900dd7fc3
 2021-04-09 15:44:08 +02:00
Laurens Valk 597b6d682f @pybricks/ide-docs v1.2.0 @pybricks/ide-docs/v1.2.0 2021-04-09 12:31:37 +02:00
Laurens Valk 9c8d41efb8 doc/index: Update install note in IDE docs. 2021-04-09 12:21:47 +02:00
Laurens Valk a06e01c6de doc/start_pup/ev3: Drop installation guide. 
These are now at https://pybricks.com/install/
 2021-04-07 19:56:56 +02:00
David Lechner 186c46f52c api/pybricks/messaging: fix BluetoothMailboxServer close 
As per standard Python socketserver, there is `server_close()` rather than `close()`.

Fixes #51
 2021-04-07 19:42:33 +02:00
Laurens Valk 7679b8b47d examples/hubs/MoveHub: imu examples 2021-02-17 23:31:19 +01:00
Laurens Valk c14f1cf473 api/hubs/MoveHub: add basic imu 
This is similar to the other hubs, but with reduced functionality.
 2021-02-17 23:23:40 +01:00
Jerry Nicholls 6ce8336c26 doc/common/Motor: fix docstring for run_target 
Changed "does" to "doesn't" for the target angle. The sign of the speed is irrelevant.
 2021-02-15 19:12:41 +01:00
Laurens Valk c46b249c8c @pybricks/ide-docs v1.1.1 @pybricks/ide-docs/v1.1.1 2021-02-14 19:32:52 +01:00
Laurens Valk 67008b67d8 doc/ide: include installation guide 2021-02-14 19:26:10 +01:00
Laurens Valk 9c1beef6b6 doc/parameters/Port: move doc to rst 2021-02-14 19:00:52 +01:00
Laurens Valk 5eb7a143fa doc/parameters/Stop: move doc to rst 2021-02-14 19:00:52 +01:00
Laurens Valk fc04059d86 doc/parameters/Button: move doc to rst 2021-02-14 19:00:45 +01:00
Laurens Valk 0082f0502a doc/parameters/Direction: move doc to rst 2021-02-14 18:44:25 +01:00
Laurens Valk e7dc4bb609 doc/parameters/Side: move doc to rst 2021-02-14 18:41:17 +01:00
Laurens Valk fb86e4bcef doc/parameters/Stop: fix typo 2021-02-14 16:21:37 +01:00
Laurens Valk 632908f59a doc/parameters: split out page per class 2021-02-14 16:06:23 +01:00
Laurens Valk 4a7fa12eaa config: add classlink directive 
We have index pages for most modules now, which link to individual classes. It is helpful if these empty class headers are hyperlinks. This commit does just that.

For most sensors/devices so far this is not really necessary as the images are already hyperlinks. But this will become more useful as we start adding index pages like these for classes without images, such as parameters.
 2021-02-14 15:39:39 +01:00
Jorge Pereira 109fcf19c1 examples/pup/motor: update motor_action_basic 
Demo of run_angle had a typo
 2021-02-14 13:54:58 +01:00
Laurens Valk 3229da030b doc/start_pup: update getting started instructions 2021-02-14 12:41:05 +01:00
Laurens Valk 4b052fa66d doc/pupdevices/motor: drop image alignment 
Fixes https://github.com/pybricks/pybricks-api/issues/40
 2021-02-12 11:10:51 +01:00
Laurens Valk 3c6ebd09bd doc/parameters/Color: add examples 2021-02-12 10:53:40 +01:00
Laurens Valk af1b84afe2 api/parameters/Color: drop name attribute 2021-02-12 10:16:43 +01:00
Laurens Valk 45dbd7db5a config: display border around white div 
Makes it easier to see white box on white background.
 2021-02-12 10:15:58 +01:00
Laurens Valk a7699d6546 api/common/Control: add load method 2021-02-10 18:49:51 +01:00
Laurens Valk 55c83cb026 api/common: add torque limit setter 
Also document units of torque
 2021-02-10 15:48:56 +01:00
David Lechner deb211bdb7 @pybricks/ide-docs v1.1.0 @pybricks/ide-docs/v1.1.0 2021-01-28 12:31:19 -06:00
David Lechner 8a5e5c3fb4 doc/ide: styling to match Pybricks Code 
We were injecting this from Pybricks code, but it caused the scroll bars
to flash when loading a page.
 2021-01-28 12:31:19 -06:00
ZPhilo 2a1640f7dc examples/pup/hubs/hub_primehub: fix button 
Corrected Bluetooth button name (from BT to BLUETOOTH)
 2021-01-28 09:31:41 +01:00
Laurens Valk 535aac8144 config: fix missing automembers in sphinx upgrade 
This setting was renamed and should now be a dictionary.

Fixes https://github.com/pybricks/pybricks-api/issues/45
 2021-01-28 09:30:23 +01:00
David Lechner 00cc5ee44e poetry: move dev dependencies to dev section 
Users who install this package from PyPi don't need all of the dev dependencies.
 2021-01-26 11:46:32 -06:00
Laurens Valk f0b882b576 config: update to Sphinx 3.4 2021-01-26 09:18:13 +01:00
Laurens Valk 8ed45aecfb doc/nxtdevices: drop method link 
For some reason, these are not working after upgrading to Sphinx 3.X, even though the same reference to conversion works just fine elsewhere.
 2021-01-26 09:07:19 +01:00
David Lechner 77605e8701 github: add workflow for publishing ide-docs package 2021-01-26 08:30:48 +01:00
David Lechner b4c8242133 doc/ide: add node package 
This will be used to publish the docs in a way that is easy for
pybricks-code to use.
 2021-01-26 08:30:48 +01:00
David Lechner 06e01e5ac8 doc/ide: use sphinx.ext.imgmath 
MathJax uses a CDN to to distribute the package. So in order to use the
docs offline, we would have to include our own copy. But it is a bit
large (50-ish MB), so it is easier to use sphinx.ext.imgmath instead
to generate svg images.

The situation might be different with MathJax v3, but that requires
Sphinx v4.
 2021-01-26 08:30:48 +01:00
David Lechner ff22c32c24 doc/api/signaltypes: use ^{\circ} instead of ° in :math: 
This works for both sphinx.ext.mathjax and sphinx.ext.imgmath.
 2021-01-26 08:30:48 +01:00
David Lechner 95eb999493 doc/api/signaltypes: fix degree symbol overlapping 
The degree symbol was a bit too close to the letters.
 2021-01-26 08:30:48 +01:00
David Lechner 7d729a8e9e doc/ide: hide the "view source" link 
Since these are meant to be offline docs and use a smaller screen area
we can omit this to keep things cleaner.
 2021-01-26 08:30:48 +01:00
David Lechner c750a3cd88 doc/ide: hide prev/next buttons 
In the IDE this is more of a reference and less of a book so going to
the next page doesn't make as much sense.
 2021-01-26 08:30:48 +01:00
David Lechner adf6e03bc9 doc: open external links in a new window 
This adds a hack to open external links in a new window. Requires Sphinx v1.8.
 2021-01-26 08:30:48 +01:00
David Lechner 0466ce947f doc: override external link style on figure target 
This works around https://github.com/readthedocs/sphinx_rtd_theme/pull/494#issuecomment-354063112
 2021-01-26 08:30:48 +01:00
David Lechner 7abb670f66 doc/ide: hide footers 
This information is duplicated in the IDE about dialog so we don't need
it in the docs.
 2021-01-26 08:30:48 +01:00