mirror of
https://github.com/pybricks/pybricks-api.git
synced 2026-09-15 02:54:52 +00:00
Laurens Valk
95b168355e
Releasing API updates is quite a long and error prone process, so the point that it was limiting our ability to push frequent updates in practice. There were 5 tag, commit, wait, and proceed steps and you'd have to start over or force push if a mistake was made. This keeps all the npm packages as they were, but versions everything from a single source of truth, which is this project's main version. Everything builds on a tag on the main repo, much like we did for a regular IDE docs RTD release. It also skips the PyPI for jedi as an intermediate step, which isn't really needed and required us to have this strict order of publication steps.
Pybricks end-user API & Documentation ===================================== This repository documents the Pybricks end-user MicroPython API. Each `Pybricks firmware`_ comes with the `Pybricks package`_. All modules, classes, methods, and functions in that package have optimized implementations in C for high performance and reduced memory footprint. This repository provides an empty, pure Python blueprint of that package. It is used to generate the `official documentation`_. See the `contributor's guide <CONTRIBUTING.md>`_ for acceptable changes and instructions to build the documentation locally. You can use the API stubs in this repository for syntax highlighting and code completion when programming the EV3 with VS Code. To enable, remove the ``"python.languageServer"="None"`` line in the ``.vscode/settings.json`` file generated by the *LEGO® MINDSTORMS® EV3 MicroPython* extension. For general discussion, please visit the `support`_ issue tracker. .. _Pybricks package: pybricks .. _Pybricks firmware: https://github.com/pybricks/pybricks-micropython .. _official documentation: https://docs.pybricks.com/ .. _support: https://github.com/pybricks/support/issues