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
752 Commits 10 Branches 125 Tags
e7dc4bb609c94d9d4961f104f652ebc105644820
Commit Graph
341 Commits
Author SHA1 Message Date
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
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 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 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
Laurens Valk 55d7a8a254 examples/pup: acceleration and angular velocity 2021-01-20 16:02:36 +01:00
Laurens Valk e051455e23 examples/pup: add imu tilt examples 2021-01-20 14:55:27 +01:00
Laurens Valk 1573508f75 examples/pup/primehub: auto rotate display 2021-01-20 11:05:09 +01:00
Laurens Valk 018b0d8b9d examples: simplify hub script generator 
Instead of saying that some lines should be skipped, just say for which hubs the entire script will work.
 2021-01-20 10:56:21 +01:00
Laurens Valk 21e5400ff3 api/common/IMU: publish draft API 2021-01-19 15:09:06 +01:00
Laurens Valk bb77e0f413 doc/hubs: link inventorhub to primehub 2021-01-19 11:45:14 +01:00
Laurens Valk c5851a3569 doc/ide: add landing page images 2021-01-19 11:42:21 +01:00
Laurens Valk 93f27f61e7 doc/hubs: make naming consistent 2021-01-19 11:19:39 +01:00
Laurens Valk 7d40e07dfb doc/hubs: InventorHub and PrimeHub on same page 
Make it a bit more explicit that they are the same.
 2021-01-19 11:18:21 +01:00
Laurens Valk 245542ce4d doc/iodevices/PUPDevice: move compatibility note 2021-01-18 16:33:14 +01:00
Laurens Valk 3cc9ec157e doc/api: avoid more ev3 references 2021-01-18 16:33:05 +01:00
Laurens Valk 9aa00fac15 doc/parameters: generalize Direction info 
Avoid links to EV3-specifics, because they may not be present in some builds.
 2021-01-18 15:36:07 +01:00
Laurens Valk db4cbe66c1 all: update copyright year 2021-01-18 14:34:28 +01:00
Laurens Valk 69c32e5c0d doc: fix image paths 
Use full path just like all other images in the api docs
 2021-01-18 12:42:15 +01:00
Laurens Valk 14ad697565 doc/start_ev3: use rst files instead of inc 
Use standard sphinx conventions as much as possible.
 2021-01-18 12:00:38 +01:00
Laurens Valk d2a6b07e0c doc/start_ev3: move download link 2021-01-18 11:52:49 +01:00
Laurens Valk 853b141153 doc/start_ev3: group as folder 2021-01-18 11:52:24 +01:00
Laurens Valk 12a6b49f97 doc/frames: drop unused file 2021-01-18 11:13:51 +01:00
Laurens Valk 8c0d7a3904 doc/parameters: drop content tabs for sides 2021-01-13 16:54:18 +01:00
Laurens Valk 9b5590047d doc/parameters: drop content tabs for ports 2021-01-13 16:54:28 +01:00
Laurens Valk 46d9e3c119 doc/iodevices: refactor 
Split all classes to their own file. This keeps things organized, and allows per-class comments about compatibility. Also flatten toggled examples.
 2021-01-13 16:54:18 +01:00
Laurens Valk bb7c9adbb8 doc/start_pup: drop toggles 2021-01-13 15:55:08 +01:00
Laurens Valk 5f4ef05c6e doc/tools: move data logging to separate page 
Expand the EV3 examples without toggles, and without making the tools page too long.
 2021-01-13 15:44:39 +01:00
Laurens Valk 5bbbff2550 doc/messaging: expand examples 
Drop use of toggle via plugin.
 2021-01-13 15:13:51 +01:00
Laurens Valk 8f637c52cd doc/media: drop toggle ui 2021-01-13 14:25:08 +01:00
Laurens Valk f826e7641c doc/media: footnote instead of toggle for language 
This is a way to make the language list non-distracting without the contentui plugin
 2021-01-12 16:50:43 +01:00
Laurens Valk 400067c364 doc/hubs/ev3brick: use footnote instead of toggle 
This is a way to make the language list non-distracting without the contentui plugin
 2021-01-12 16:50:18 +01:00
Laurens Valk 05ecf8bcb6 doc/hubs: show IMU on Prime and Technic Hub 2021-01-05 16:31:35 +01:00
Laurens Valk 1f991302e5 doc/common: fix unit of acceleration 2021-01-05 16:31:35 +01:00
Laurens Valk f3f0532f74 doc/hubs: move note about identical classes 
Otherwise, it was shown after the newly added __init__ docstring, which was confusing.
 2021-01-05 16:31:35 +01:00
Laurens Valk 64146f5afa doc/geometry: axis and orientation conventions 2021-01-05 16:31:21 +01:00
Laurens Valk e52130b627 api/hubs/inventorhub: enable IMU 
The minimal change to start reviewing and improving IMU api and docs.
 2021-01-04 17:25:16 +01:00
Laurens Valk a2583944d9 api/geometry: move Axis from parameters 
This location makes more sense. Also drop Axis.ANY = None, which is more confusing than helpful. Instead, use relevant docstring to explain what None will do.
 2021-01-04 17:25:15 +01:00
Laurens Valk 4c6c149d4a doc/start_pup: update link to CI builds 2021-01-04 15:28:03 +01:00
Laurens Valk 9835ee9dbe doc/hubs/primehub: update button graphic 
The graphic showed Button.BT but it is now Button.BLUETOOTH
 2020-12-30 12:42:47 +01:00
Laurens Valk 352bff564c api/parameters/Button: add remote buttons 
Also clean up how it is displayed by reading the attributes from the API instead of copying them.
 2020-12-30 12:27:12 +01:00
Laurens Valk 313a51219a api/pupdevices/Remote: add address 
After connecting (automatically), this address can be printed so next time you can connect directly without scanning.

This is useful if you have more than one remote.
 2020-12-29 20:16:34 +01:00
Laurens Valk c2d2884794 api/pupdevices/Remote: publish draft api 2020-12-29 19:51:48 +01:00
Laurens Valk 32a47bcee0 doc/nxtdevices: do not collapse example 
In the long run, this page needs to be split up just like pupdevices. At this time, the nxtdevices page has only one example, so we simply remove the toggle header.
 2020-12-29 14:53:13 +01:00