v3: Drop parameters Side and Button.

This commit is contained in:
Laurens Valk
2021-04-12 11:05:26 +02:00
parent 5effd921b4
commit 8dd171fc4c
5 changed files with 23 additions and 61 deletions
-3
View File
@@ -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
-55
View File
@@ -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
-1
View File
@@ -1 +0,0 @@
.. include:: ../../api/parameters/button.rst
+23 -1
View File
@@ -1 +1,23 @@
.. include:: ../../api/parameters/index.rst
:mod:`parameters <pybricks.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
-1
View File
@@ -1 +0,0 @@
.. include:: ../../api/parameters/side.rst