mirror of
https://github.com/pybricks/pybricks-api.git
synced 2026-09-12 01:24:17 +00:00
doc/parameters/Side: move doc to rst
This commit is contained in:
@@ -45,5 +45,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 <.parameters.Side>` of the hub are pointing. The example
|
||||
front :class:`Side <Side>` of the hub are pointing. The example
|
||||
on the left is the default configuration.
|
||||
|
||||
@@ -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
|
||||
|
||||
Reference in New Issue
Block a user