mirror of
https://github.com/pybricks/pybricks-api.git
synced 2026-07-28 04:07:46 +00:00
Laurens Valk
238204d280
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.
72 lines
1.5 KiB
ReStructuredText
72 lines
1.5 KiB
ReStructuredText
Pybricks Documentation
|
|
==================================================================
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Pybricks Modules
|
|
:hidden:
|
|
|
|
hubs/index
|
|
pupdevices/index
|
|
iodevices/index
|
|
parameters/index
|
|
tools/index
|
|
robotics
|
|
geometry
|
|
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: MicroPython Modules
|
|
:hidden:
|
|
|
|
micropython/index
|
|
micropython/micropython
|
|
micropython/uerrno
|
|
micropython/uio
|
|
micropython/umath
|
|
micropython/urandom
|
|
micropython/uselect
|
|
micropython/usys
|
|
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Engineering Extras
|
|
:hidden:
|
|
|
|
signaltypes
|
|
motors
|
|
|
|
.. note::
|
|
|
|
**You are using a new beta version of Pybricks!**
|
|
|
|
This is great for trying the very latest features, but some things
|
|
might not work.
|
|
|
|
If in doubt, use the `latest stable release`_. Please report any
|
|
issues via our `support page`_. Thanks!
|
|
|
|
To begin, install the Pybricks firmware on your hub. Check
|
|
`pybricks.com/install`_ to learn how.
|
|
|
|
Use the ☰ menu to navigate all available classes, methods, and tools. A few
|
|
commonly used devices and classes are listed below for quick reference.
|
|
|
|
.. rubric:: Programmable Hubs
|
|
|
|
.. figure:: ../main/images/hubsoverview.png
|
|
:width: 100 %
|
|
:target: hubs/index.html
|
|
|
|
.. rubric:: Powered Up Motors and Sensors
|
|
|
|
.. figure:: ../main/images/pupdevicesoverview.png
|
|
:width: 100 %
|
|
:target: pupdevices/index.html
|
|
|
|
.. _pybricks.com/install: https://pybricks.com/install/
|
|
.. _latest stable release: https://www.code.pybricks.com/
|
|
.. _support page: https://github.com/pybricks/support
|