Michel2/pybricks-api
1
0
Fork 0
mirror of https://github.com/pybricks/pybricks-api.git synced 2026-09-11 09:05:07 +00:00
Code Issues Releases Activity
1,380 Commits 10 Branches 125 Tags
4ade3939ae488467b8a477fe2887f93eb993cc81
Commit Graph
42 Commits
Author SHA1 Message Date
Laurens Valk 7409057b9c pybricks: Indexing fixes. 
The noindex made them not show up. Also fix misc related indexing issues.
 2026-06-01 16:26:24 +02:00
Laurens Valk 2380be2814 extensions/blockimg: Embed svg. 
This cuts the total build from 527 to 156 files,
which is considerably fewer requests when loading
this inside Pybricks Code.

See https://github.com/pybricks/support/issues/1559
 2025-02-26 10:58:03 +01:00
Laurens Valk 1e09cb2232 builtins: Document missing eval and exec on Move Hub. 
Fixes https://github.com/pybricks/support/issues/1931
 2025-02-25 11:32:01 +01:00
Laurens Valk ea4f594696 builtins: Update list blocks. 2024-03-11 13:43:45 +01:00
Laurens Valk 296eb0f234 blocks: Include display. 2023-11-28 15:06:45 +01:00
Laurens Valk 43f0e72a09 blocks: Initial round of images. 2023-11-28 15:06:45 +01:00
David Lechner 3335042218 ubuiltins: add set class 
Add type stubs and docs for builtin `set` type.

Issue: https://github.com/pybricks/support/issues/402
 2023-10-26 09:21:41 +02:00
David Lechner 8e5891d9e8 all: spelling 
Misc spelling fixes.
 2023-05-10 14:16:15 -05:00
Laurens Valk 961cebe48b ustruct: Document modules. 2022-12-01 16:48:20 +01:00
Laurens Valk 3c0aaea207 usys: Add version info. 
Fixes https://github.com/pybricks/pybricks-api/issues/119
 2022-12-01 15:02:25 +01:00
Laurens Valk 553490874b usys: Add examples. 2022-12-01 14:21:12 +01:00
Laurens Valk 31d3872405 uselect: Rewrite the docs. 2022-12-01 14:11:41 +01:00
Laurens Valk 6f55e90365 urandom: Update remaining functions. 
Also modify the categories given implicitly in the Python
file and make them explicit in the docs.

Most users are going to want to use `randint` or `random`, so
that basic category comes first.
 2022-12-01 11:19:42 +01:00
Laurens Valk 87ed7353b4 ujson, urandom, uselect: Document compatibility. 2022-11-29 20:32:53 +01:00
Laurens Valk aca23197a1 micropython: Document compatibility. 
Fixes https://github.com/pybricks/pybricks-api/issues/118
 2022-11-29 20:32:09 +01:00
Laurens Valk 71ce165a46 uio: Update style. 
Also fix compatibility information.
 2022-11-29 20:23:23 +01:00
Laurens Valk 56ab509630 ujson: Document module. 2022-11-29 16:00:00 +01:00
Laurens Valk 9608a16d95 micropython: Update style. 
This makes it consistent with our other modules.

Follows https://github.com/pybricks/pybricks-api/issues/82
 2022-11-29 15:59:32 +01:00
Laurens Valk 9b314777e0 micropython: Document heap_lock, heap_unlock. 
Fixes https://github.com/pybricks/pybricks-api/issues/116
 2022-11-29 13:51:34 +01:00
Laurens Valk 0982d5d65b ubuiltins: Document int. 2022-07-04 14:33:17 +02:00
Laurens Valk dd2e6e8603 ubuiltins.int: Document from_bytes manually. 
Sphinx fails to show the docsting for class methods. Since we have very few of them, it is easier to just document this one manually

Fixes https://github.com/pybricks/pybricks-api/issues/86
 2021-08-22 12:15:42 +02:00
Laurens Valk d86b5584fb ubuiltins: Type enumerate as a class. 
This reverts commit a0ea0d8ca0 because of https://github.com/pybricks/pybricks-api/issues/72
 2021-08-06 09:51:52 +02:00
Laurens Valk 1c01e981e0 usys: Clean up. 
Add requirements, drop autodoc, and add a few cross references.
 2021-08-05 16:13:50 +02:00
Laurens Valk b3c5353dd6 ubuiltins: Reorganize page. 
Fixes https://github.com/pybricks/pybricks-api/issues/80
 2021-08-05 12:32:41 +02:00
Laurens Valk 0ecf536cda ubuiltins: Add compatibility everywhere. 
This lets us sort everything by category or alphabetically without having to make special categories for Move Hub.
 2021-08-05 12:32:37 +02:00
David Lechner f2124615ba ubuiltins: List decorators in separate section. 
This moves the built-in decorators to their own section and uses
`autodecorator` to indicate they are decorators.
 2021-08-05 12:32:29 +02:00
Laurens Valk 979da8b170 pybricks.pupdevices: Show compatibility. 2021-08-05 12:32:03 +02:00
Laurens Valk ac4a913be3 doc/common/requirements: Toggle hub table. 
This makes it possible to hide/unhide the compatibility table.

It is adapted from the sphinxcontrib-contentui extension: https://github.com/ulrobix/sphinxcontrib-contentui
 2021-08-05 12:32:03 +02:00
Laurens Valk 31a30f380f doc/common/requirements: Rename to static. 
We will work on a version that can be toggled dynamically. It will just include this static version. This keeps things simple and still lets
us use the static version as needed.
 2021-08-05 12:32:03 +02:00
Laurens Valk 75bc15f071 ubuiltins: Add bytearray. 2021-08-05 12:32:03 +02:00
Laurens Valk 0b9280a8df uerrno: Display on separate page. 
Fixes https://github.com/pybricks/pybricks-api/issues/78
 2021-08-02 11:01:20 +02:00
Laurens Valk be0903de9e doc/common/extensions: Basic styling. 
Turns it into a table with images, using builtin RTD classes for CSS.
 2021-07-26 15:47:02 +02:00
Laurens Valk cefa78270a doc/common/extensions: Add requirements directive. 
Displays compatibility for each hub depending on its features.
 2021-07-26 12:18:55 +02:00
Laurens Valk 72e0d87f77 ubuiltins: Examples for common exceptions. 2021-07-21 14:53:56 +02:00
Laurens Valk 923e8caf84 ubuiltins: Organize exceptions. 2021-07-21 11:12:51 +02:00
Laurens Valk e8d47ffca1 uerrno: Document alongside OSError. 
These are meant to be used together, so document them in the same place along with a practical example.
 2021-07-19 15:03:10 +02:00
Laurens Valk 64ea5e341c ubuiltins: Sort classes and functions by use case. 2021-07-16 16:07:55 +02:00
Laurens Valk 29404babcf ubuiltins: Split out automodule. 
List all functions and classes explicitly so we can organize them by category in later commits.

Also split out exceptions and uerrno to dedicated page because the builtins page was getting very long and hard to navigate.
 2021-07-16 16:07:46 +02:00
Laurens Valk 3b1fd091f1 micropython: Add examples for memory stats. 2021-07-14 16:08:52 +02:00
Laurens Valk 4c00c3209b micropython.const: Improve docstring, add example. 
This merges the useful information from two different places:
- The original docstring for const.
- Writing MicroPython code for constrained devices.

Also reduce type to just int, because only ints are supported.
 2021-07-14 14:48:59 +02:00
Laurens Valk c656eae2f3 micropython: Drop TConst type. 
TConst does not exist, so adding it makes it a bit harder to read than needed. The const() "function" will take int or float, and the return value can be used as such, even if it is optimized out. This is described in the docstring, so we can leave out the additional type.

Also adds autofunctions in place of one auto module so we can move things around as needed. Also fix cross links with usys to get the build to pass before we update that module.
 2021-07-14 14:13:18 +02:00
Laurens Valk 238204d280 doc/main: Rename from doc/api. 
The doc/api is a legacy name, which is confusing in the current use, since all build targets are now APIs.

Today we have:

doc/common: Common configuration and settings between all targets.

doc/main: Main Pybricks documentation at docs.pybricks.com.

doc/ide: Documentation shipped with the Pybricks Code IDE.
 2021-07-14 11:39:20 +02:00