From 5ecad4a8453f3d638fd611a3aa81bdeac3adb126 Mon Sep 17 00:00:00 2001 From: Laurens Valk Date: Mon, 1 Jun 2026 15:18:09 +0200 Subject: [PATCH] pybricks.parameters. Document with full namespace. This types them in full for the object index. --- doc/main/hubs/primehub.rst | 2 ++ doc/main/parameters/button.rst | 2 ++ doc/main/parameters/direction.rst | 2 ++ doc/main/parameters/port.rst | 2 ++ doc/main/parameters/side.rst | 2 ++ doc/main/parameters/stop.rst | 2 ++ doc/main/signaltypes.rst | 2 +- 7 files changed, 13 insertions(+), 1 deletion(-) diff --git a/doc/main/hubs/primehub.rst b/doc/main/hubs/primehub.rst index 564f2bf..d79a70f 100644 --- a/doc/main/hubs/primehub.rst +++ b/doc/main/hubs/primehub.rst @@ -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 diff --git a/doc/main/parameters/button.rst b/doc/main/parameters/button.rst index e678f8b..90872d6 100644 --- a/doc/main/parameters/button.rst +++ b/doc/main/parameters/button.rst @@ -3,6 +3,8 @@ Button ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +.. currentmodule:: pybricks.parameters + .. class:: Button .. rubric:: Remote and hub buttons diff --git a/doc/main/parameters/direction.rst b/doc/main/parameters/direction.rst index 7010d04..74842ed 100644 --- a/doc/main/parameters/direction.rst +++ b/doc/main/parameters/direction.rst @@ -3,6 +3,8 @@ Direction ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +.. currentmodule:: pybricks.parameters + .. class:: Direction Rotational direction for positive speed or angle values. diff --git a/doc/main/parameters/port.rst b/doc/main/parameters/port.rst index 2098e3d..273eaf8 100644 --- a/doc/main/parameters/port.rst +++ b/doc/main/parameters/port.rst @@ -3,6 +3,8 @@ Port ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +.. currentmodule:: pybricks.parameters + .. class:: Port Input and output ports: diff --git a/doc/main/parameters/side.rst b/doc/main/parameters/side.rst index 93d9319..1fa3725 100644 --- a/doc/main/parameters/side.rst +++ b/doc/main/parameters/side.rst @@ -3,6 +3,8 @@ Side ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +.. currentmodule:: pybricks.parameters + .. class:: Side Side of a hub or a sensor. These devices are diff --git a/doc/main/parameters/stop.rst b/doc/main/parameters/stop.rst index 8c24ee3..693ac3f 100644 --- a/doc/main/parameters/stop.rst +++ b/doc/main/parameters/stop.rst @@ -3,6 +3,8 @@ Stop ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +.. currentmodule:: pybricks.parameters + .. class:: Stop Action after the motor stops. diff --git a/doc/main/signaltypes.rst b/doc/main/signaltypes.rst index 91e174d..5fe8ef6 100644 --- a/doc/main/signaltypes.rst +++ b/doc/main/signaltypes.rst @@ -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 ` of the hub are pointing. The example + front :class:`Side ` of the hub are pointing. The example on the left is the default configuration.