Michel2/pybricks-api
1
0
Fork 0
mirror of https://github.com/pybricks/pybricks-api.git synced 2026-07-27 19:57:02 +00:00
Code Issues Releases Activity

index: Simplify landing.

Browse Source 
Docs are great if you know what to look for already. Otherwise it is better to start in the welcome guide.
This commit is contained in:
Laurens Valk
2026-06-02 12:01:00 +02:00
parent b891f6c35e
commit 7895cac17f
2 changed files with 19 additions and 164 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/main/blocks/index.rst
-148
View File
@@ -1,148 +0,0 @@
.. pybricks-requirements::
Other blocks
=====================================================
Most blocks correspond directly to one of the documented Python commands. This
page lists the remaining blocks.
This page will be expanded with more details in the next release.
Math
------------------------
See also :mod:`umath` for other math operations.
.. blockimg:: pybricks_blockMathFormula
.. blockimg:: pybricks_blockMathOp_modulo
.. blockimg:: pybricks_blockMathArithmetic_add
.. blockimg:: pybricks_blockMathArithmetic_minus
.. blockimg:: pybricks_blockMathArithmetic_multiply
.. blockimg:: pybricks_blockMathArithmetic_divide
.. blockimg:: pybricks_blockMathArithmetic_power
Logic
--------------------------
.. blockimg:: pybricks_blockLogicCompareDouble
.. blockimg:: pybricks_blockLogicCompare_eq
.. blockimg:: pybricks_blockLogicCompare_gte
.. blockimg:: pybricks_blockLogicCompare_gt
.. blockimg:: pybricks_blockLogicCompare_lte
.. blockimg:: pybricks_blockLogicCompare_lt
.. blockimg:: pybricks_blockLogicCompare_neq
.. blockimg:: pybricks_blockLogicIsNone_is_none
.. blockimg:: pybricks_blockLogicIsNone_is_not_none
.. blockimg:: pybricks_blockLogicIsNone_not
.. blockimg:: pybricks_blockLogicOperation_and
.. blockimg:: pybricks_blockLogicOperation_or
.. blockimg:: pybricks_blockLogicTernary
.. blockimg:: pybricks_blockLogicTernaryDouble
.. blockimg:: pybricks_blockIsIn
Flow
--------------------------
.. blockimg:: pybricks_blockFlowBreakContinue_break
.. blockimg:: pybricks_blockFlowBreakContinue_continue
.. blockimg:: pybricks_blockFlowForEach_loop_for
.. blockimg:: pybricks_blockFlowForEach_loop_for_list
.. blockimg:: pybricks_blockFlowForEach_loop_for_range
.. blockimg:: pybricks_blockFlowRepeat
.. blockimg:: pybricks_blockFlowWhile_until
.. blockimg:: pybricks_blockFlowWhile_while
.. blockimg:: pybricks_blockIfElse_if_else
.. blockimg:: pybricks_blockIfElse_if_else_else
.. blockimg:: pybricks_blockIfElse_if_only
Device and system setup
--------------------------
.. blockimg:: pybricks_blockGlobalSetup
Waiting
------------------------
.. blockimg:: pybricks_blockWaitTime
.. blockimg:: pybricks_blockWaitUntil
.. blockimg:: pybricks_blockWaitForever
Variables
--------------------------
.. blockimg:: pybricks_variables_setup_any
.. blockimg:: pybricks_blockVariableGetValue
.. blockimg:: pybricks_blockVariableSetValue
Multitasking
--------------------------
.. blockimg:: pybricks_blockGlobalStart
.. blockimg:: pybricks_blockMultiTask
Your own tasks
--------------------------
.. blockimg:: pybricks_variables_setup_function_basic
.. blockimg:: pybricks_variables_setup_function_with_args
.. blockimg:: pybricks_blockTaskReturn
External tasks
--------------------------
.. blockimg:: pybricks_variables_setup_imported_function
.. blockimg:: pybricks_blockImportTaskCallStatement
.. blockimg:: pybricks_blockImportTaskCallValue
Comments
--------------------------
.. blockimg:: pybricks_blockComment
Stopping programs
--------------------------
.. blockimg:: pybricks_blockProgramStop
doc/main/index.rst
+19 -16
View File
@@ -1,19 +1,24 @@
Pybricks Documentation
Pybricks Reference Manual
==================================================================
`Pybricks <https://pybricks.com/>`_ is Python coding for smart LEGO® hubs.
Run MicroPython scripts
directly on the hub, and get full control of your motors and sensors.
.. only:: ide
Pybricks runs on LEGO® BOOST, City, Technic, MINDSTORMS®, and SPIKE®. You
can code using Windows, Mac, Linux, Chromebook, and Android.
This documentation details all available functions and classes in Pybricks.
For example, you can find the meaning of specific function parameters like
motor speed.
Click on any device below to see its documentation. Use the menu on the left
to find documentation for additional modules. You may need to click the ☰ icon
above to reveal this menu.
If you are new to Pybricks, we recommend starting with the `Pybricks learn`_
guide instead.
.. only:: main
`Pybricks <https://pybricks.com/>`_ is Python coding for smart LEGO® hubs.
Run MicroPython scripts
directly on the hub, and get full control of your motors and sensors.
Pybricks runs on LEGO® BOOST, City, Technic, MINDSTORMS®, and SPIKE®. You
can code using Windows, Mac, Linux, Chromebook, and Android.
.. note:: You are viewing the stand-alone version of the documentation. To
learn more about Pybricks and to start coding, visit
the `Pybricks website`_
@@ -21,8 +26,13 @@ above to reveal this menu.
.. note:: Are you using LEGO MINDSTORMS EV3? Check out the
`EV3 documentation`_ instead.
Click on any device below to see its documentation. Use the menu on the left
to find documentation for additional modules. You may need to click the ☰ icon
above to reveal this menu.
.. _EV3 documentation: https://pybricks.com/ev3-micropython/
.. _Pybricks website: https://pybricks.com/
.. _Pybricks learn: https://pybricks.com/learn/
.. rubric:: Programmable hubs
@@ -63,13 +73,6 @@ above to reveal this menu.
messaging/index
signaltypes
.. toctree::
:maxdepth: 1
:caption: Code with blocks
:hidden:
blocks/index
.. toctree::
:maxdepth: 1
:caption: MicroPython modules