pybricks.parameters. Document with full namespace.

This types them in full for the object index.
This commit is contained in:
Laurens Valk
2026-06-01 15:18:09 +02:00
parent a402ae02e9
commit 5ecad4a845
7 changed files with 13 additions and 1 deletions
+2
View File
@@ -10,6 +10,8 @@ Prime Hub / Inventor Hub
.. blockimg:: pybricks_variables_set_inventor_hub_option4
.. currentmodule:: pybricks.hubs
.. class:: InventorHub
This class is the same as the ``PrimeHub`` class, shown below. Both classes
+2
View File
@@ -3,6 +3,8 @@
Button
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. currentmodule:: pybricks.parameters
.. class:: Button
.. rubric:: Remote and hub buttons
+2
View File
@@ -3,6 +3,8 @@
Direction
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. currentmodule:: pybricks.parameters
.. class:: Direction
Rotational direction for positive speed or angle values.
+2
View File
@@ -3,6 +3,8 @@
Port
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. currentmodule:: pybricks.parameters
.. class:: Port
Input and output ports:
+2
View File
@@ -3,6 +3,8 @@
Side
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. currentmodule:: pybricks.parameters
.. class:: Side
Side of a hub or a sensor. These devices are
+2
View File
@@ -3,6 +3,8 @@
Stop
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. currentmodule:: pybricks.parameters
.. class:: Stop
Action after the motor stops.
+1 -1
View File
@@ -291,5 +291,5 @@ though the *hub* accelerates backward.
How to configure the ``top_side`` and ``front_side`` settings for three
different robot designs. The same technique can be applied to other hubs
and other creations, by noting which way the top and
front :class:`Side <Side>` of the hub are pointing. The example
front :class:`Side <pybricks.parameters.Side>` of the hub are pointing. The example
on the left is the default configuration.