David Lechner
0eb0e160e9
micropython: Add stubs and docs for micropython module
...
Issue: https://github.com/pybricks/support/issues/236
2021-07-14 09:41:30 +02:00
Laurens Valk
5a8baeff4c
pybricks.hubs: Add system examples.
2021-07-07 09:58:51 +02:00
Laurens Valk
a2801aff41
pybricks.hubs: Enable single button.
2021-07-07 09:47:28 +02:00
Laurens Valk
76432120c4
pybricks.common.System: Add shutdown method.
...
Also drop reset() and update reset_reason() after https://github.com/pybricks/support/issues/379
2021-07-07 09:47:35 +02:00
Laurens Valk
3ce741ac2b
pybricks.common.System: Add initial documentation.
2021-07-07 09:47:28 +02:00
Laurens Valk
f8cd3451ea
pupdevices.Remote: Enable it.
...
Also add an example.
2021-06-30 17:14:25 +02:00
Laurens Valk
7f0b1489a2
ide: Re-enable 3.X features.
...
These were hidden for the 3.0 release, but we can re-enable them for
the beta release of 3.1.
Revert "v3: Drop parameters Side and Button."
This reverts commit 07c53e9a3d .
Revert "v3: Drop Remote control."
This reverts commit b600f5029e .
Revert "v3: Drop geometry module."
This reverts commit 5f767f3fee .
Revert "v3: Drop Prime Hub and Inventor Hub."
This reverts commit 8db7892f8c .
Revert "v3: Drop IMU documentation."
This reverts commit b325bf4bff .
2021-06-23 19:41:15 +02:00
Laurens Valk
07c53e9a3d
v3: Drop parameters Side and Button.
2021-06-23 19:35:58 +02:00
Laurens Valk
b600f5029e
v3: Drop Remote control.
2021-06-23 19:35:58 +02:00
Laurens Valk
5f767f3fee
v3: Drop geometry module.
2021-06-23 19:35:57 +02:00
Laurens Valk
8db7892f8c
v3: Drop Prime Hub and Inventor Hub.
2021-06-23 19:35:57 +02:00
Laurens Valk
b325bf4bff
v3: Drop IMU documentation.
...
This is not officially supported yet, so drop from release docs.
2021-06-23 19:35:57 +02:00
David Lechner
5d355e9892
doc/api/media: fix audio playback
...
Sphinx changed how filenames are generated which broke media playback.
The file name now includes the MD5 hash of the filename passed to the
:download: directive.
This was done with the following script:
for f in $(find media/ev3dev-media/ -name "*.wav" -exec bash -c 'echo "$(echo -n ../../'{}' | md5sum)/$(basename '{}')"' \;); do
sed -i "s,_downloads/$(basename $f),_downloads/$f," doc/api/media.rst;
done
2021-06-04 12:45:44 -05:00
Laurens Valk
3b20a811cb
examples/pup/motor_dc: Add battery box example.
2021-05-21 14:00:57 +02:00
Laurens Valk
790fcfa66a
examples/pup/iodevices: Add PUPDevice example.
2021-04-29 13:03:34 +02:00
Laurens Valk
ca96ee2fce
examples: Update detectable colors API.
2021-04-10 15:31:28 +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
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
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
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