Michel2/pybricks-api
1
0
Fork 0
mirror of https://github.com/pybricks/pybricks-api.git synced 2026-09-12 01:24:17 +00:00
Code Issues Releases Activity

doc/parameters/Side: move doc to rst

Browse Source
This commit is contained in:
Laurens Valk
2021-02-14 18:41:17 +01:00
parent fb86e4bcef
commit e7dc4bb609
4 changed files with 31 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/api/parameters/side.rst
+28 -7
View File
@@ -1,8 +1,29 @@
Side
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: pybricks.parameters.Side
:no-members:
.. 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
@@ -11,24 +32,24 @@ Side
**Prime Hub**
.. figure:: ../../api/images/orientation_primehub_label.png
:height: 15 em
:height: 17 em
**Inventor Hub**
.. figure:: ../../api/images/orientation_inventorhub_label.png
:height: 15 em
:height: 17 em
**Move Hub**
.. figure:: ../../api/images/orientation_movehub_label.png
:height: 15 em
:height: 17 em
**Technic Hub**
.. figure:: ../../api/images/orientation_technichub_label.png
:height: 15 em
:height: 17 em
**Tilt Sensor**
.. figure:: ../../api/images/orientation_tiltsensor_label.png
:height: 15 em
:height: 17 em