diff --git a/doc/api/parameters/index.rst b/doc/api/parameters/index.rst index b60b861..ed52655 100644 --- a/doc/api/parameters/index.rst +++ b/doc/api/parameters/index.rst @@ -12,7 +12,6 @@ color direction port - side stop .. pybricks-classlink:: Button @@ -23,7 +22,5 @@ .. pybricks-classlink:: Port -.. pybricks-classlink:: Side - .. pybricks-classlink:: Stop diff --git a/doc/api/parameters/side.rst b/doc/api/parameters/side.rst deleted file mode 100644 index 5a7cbcf..0000000 --- a/doc/api/parameters/side.rst +++ /dev/null @@ -1,55 +0,0 @@ -Side -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. class:: Side - - Side of a hub or a sensor. These devices are - mostly rectangular boxes with six sides: - - .. autoattribute:: pybricks.parameters.Side.TOP - :annotation: - - .. autoattribute:: pybricks.parameters.Side.BOTTOM - :annotation: - - .. autoattribute:: pybricks.parameters.Side.FRONT - :annotation: - - .. autoattribute:: pybricks.parameters.Side.BACK - :annotation: - - .. autoattribute:: pybricks.parameters.Side.LEFT - :annotation: - - .. autoattribute:: pybricks.parameters.Side.RIGHT - :annotation: - - - Screens or light matrices have only four sides. For those, - ``TOP`` is treated the same as ``FRONT``, and ``BOTTOM`` is treated the - same as ``BACK``. The diagrams below define the sides for relevant devices. - - **Prime Hub** - - .. figure:: ../../api/images/orientation_primehub_label.png - :height: 17 em - - **Inventor Hub** - - .. figure:: ../../api/images/orientation_inventorhub_label.png - :height: 17 em - - **Move Hub** - - .. figure:: ../../api/images/orientation_movehub_label.png - :height: 17 em - - **Technic Hub** - - .. figure:: ../../api/images/orientation_technichub_label.png - :height: 17 em - - **Tilt Sensor** - - .. figure:: ../../api/images/orientation_tiltsensor_label.png - :height: 17 em diff --git a/doc/ide/parameters/button.rst b/doc/ide/parameters/button.rst deleted file mode 100644 index a57672c..0000000 --- a/doc/ide/parameters/button.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../api/parameters/button.rst diff --git a/doc/ide/parameters/index.rst b/doc/ide/parameters/index.rst index 527df35..5d75f32 100644 --- a/doc/ide/parameters/index.rst +++ b/doc/ide/parameters/index.rst @@ -1 +1,23 @@ -.. include:: ../../api/parameters/index.rst +:mod:`parameters ` -- Parameters and Constants +=================================================================== + +.. automodule:: pybricks.parameters + :no-members: + +.. toctree:: + :maxdepth: 1 + :hidden: + + color + direction + port + stop + +.. pybricks-classlink:: Color + +.. pybricks-classlink:: Direction + +.. pybricks-classlink:: Port + +.. pybricks-classlink:: Stop + diff --git a/doc/ide/parameters/side.rst b/doc/ide/parameters/side.rst deleted file mode 100644 index 196abdf..0000000 --- a/doc/ide/parameters/side.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../api/parameters/side.rst