Laurens Valk
1fab46e67f
doc/main/index: Clean up menu and builtins.
...
There is no ubuiltins module, so we shouldn't mention it.
Also reduce size of other module titles so they fit on one line in the
menu. This makes it easier to read and get an overview.
2021-07-14 11:39:20 +02:00
Laurens Valk
727ec3fe46
umath: Redo module docs.
...
This reworks the documentation for the umath module, as done previously as per https://github.com/pybricks/pybricks-api/pull/64 and https://github.com/pybricks/pybricks-api/issues/63
The presentation and docstrings are inspired by the Python 3 math module documentation instead of the MicroPython math module documentation. Functions are grouped roughly by use case.
2021-07-14 11:22:04 +02:00
Laurens Valk
a0e4ffdb5c
umath: Use umath for math.
...
Do this for all Powered Up examples.
2021-07-14 11:22:04 +02:00
Laurens Valk
9b8a66e3da
pybricks.hubs.PrimeHub: Add system examples.
2021-07-14 09:43:34 +02:00
Laurens Valk
9944cf3adf
pybricks.common.System: Add name() getter.
2021-07-14 09:43:20 +02:00
David Lechner
286079fe68
ubuiltins: add stubs and docs for ubuiltins module
...
Issue: https://github.com/pybricks/support/issues/236
2021-07-14 09:41:30 +02:00
David Lechner
d492b04402
umath: add stubs and docs for umath module
...
Issue: https://github.com/pybricks/support/issues/236
2021-07-14 09:41:30 +02:00
David Lechner
818409f675
usys: add stubs and docs for usys module
...
Issue: https://github.com/pybricks/support/issues/236
2021-07-14 09:41:30 +02:00
David Lechner
9dd131142e
uselect: add stubs and docs for uselect module
...
Issue: https://github.com/pybricks/support/issues/236
2021-07-14 09:41:30 +02:00
David Lechner
f828d11f40
urandom: add stubs and docs for urandom module
...
Issue: https://github.com/pybricks/support/issues/236
2021-07-14 09:41:30 +02:00
David Lechner
532639b820
uio: add stubs and docs for uio module
...
Issue: https://github.com/pybricks/support/issues/236
2021-07-14 09:41:30 +02:00
David Lechner
0865a58632
uerrno: add uerrno module stubs and docs
...
Issue: https://github.com/pybricks/support/issues/236
2021-07-14 09:41:30 +02:00
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
David Lechner
7126431f9f
pybricks: move into src/ directory
...
Moving the pybricks package into a src/ directory so that we can add
additional packages without polluting the top-level directory.
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
ce1456cb92
@pybricks/ide-docs v1.5.0
@pybricks/ide-docs/v1.5.0
2021-07-01 15:56:32 +02:00
Laurens Valk
f8cd3451ea
pupdevices.Remote: Enable it.
...
Also add an example.
2021-06-30 17:14:25 +02:00
Laurens Valk
cb84ca87c6
@pybricks/ide-docs v1.4.0
@pybricks/ide-docs/v1.4.0
2021-06-23 19:56:31 +02:00
Laurens Valk
e1995f9d1b
ide: Display note about beta version.
2021-06-23 19:50:51 +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
aa2019be02
@pybricks/ide-docs v1.3.3
2021-06-23 19:36:00 +02:00
Laurens Valk
1ac78b5b82
@pybricks/ide-docs v1.3.2
2021-06-23 19:35:59 +02:00
Laurens Valk
847a3d5eec
@pybricks/ide-docs v1.3.1
2021-06-23 19:35:59 +02:00
Laurens Valk
1a208ddd25
@pybricks/ide-docs v1.3.0
2021-06-23 19:35:59 +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
David Lechner
73cc441edb
github: add release action
...
This publishes the Python package to PyPI when a release is created on
GitHub.
v3.0.0c1
2021-05-17 16:42:16 -05:00
David Lechner
7770a88aa0
github: fix build action name
...
It does more than just build the Python package.
2021-05-17 16:38:58 -05:00
David Lechner
f06caa32bc
3.0.0-rc.1
2021-05-17 16:35:37 -05:00
thesynman
fb8198fe8f
pybricks/robotics.pyi: improve type hint ( #60 )
...
* Allow the wheel diameter and axle track of a DriveBase to be an int or a float
2021-05-10 13:08:25 -05:00
David Lechner
3dad15ac11
examples: fix use of OSError
...
We generally shouldn't be raising OSError from user code since it
represents an error the bubbles up from the OS. Also, when handling
an OSError, we almost always want to check for a specific error code.
2021-04-29 09:38:16 -05:00
Laurens Valk
790fcfa66a
examples/pup/iodevices: Add PUPDevice example.
2021-04-29 13:03:34 +02:00
David Lechner
d108d7c163
doc/common/conf: use xcode syntax highlighting
...
This matches the style used in Pybricks Code.
2021-04-28 15:54:11 -05:00
Martyn Boogaarts
7ce3721b48
examples/pup/hub_shared: Update light animation examples.
...
See https://github.com/pybricks/support/issues/253
* Update light_animate.py
corrected syntax
* Update light_animate.py
corrected syntax
* Update light_animate.py
corrected syntax
* Update light_animate.py
corrected syntax
2021-04-24 21:36:10 +02:00
David Lechner
d0bfbcb4d1
js: only apply target="_blank" to IDE build
...
On the web, we want to be able to navigate between the various Pybricks
subdomains without opening new tabs. But Pybricks Code is treated as an
"app", we don't want links to open in Pybricks Code.
2021-04-20 12:38:33 -05:00
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