Files
pybricks-api/doc/api/pupdevices/index.rst
T
Laurens Valk 4a7fa12eaa config: add classlink directive
We have index pages for most modules now, which link to individual classes. It is helpful if these empty class headers are hyperlinks. This commit does just that.

For most sensors/devices so far this is not really necessary as the images are already hyperlinks. But this will become more useful as we start adding index pages like these for classes without images, such as parameters.
2021-02-14 15:39:39 +01:00

88 lines
1.7 KiB
ReStructuredText

:mod:`pupdevices <pybricks.pupdevices>` -- Powered Up Devices
=============================================================
.. automodule:: pybricks.pupdevices
:no-members:
.. toctree::
:maxdepth: 1
:hidden:
dcmotor
motor
tiltsensor
infraredsensor
colordistancesensor
pfmotor
colorsensor
ultrasonicsensor
forcesensor
light
remote
.. pybricks-classlink:: DCMotor
.. figure:: ../../api/images/pupdcmotors_label.png
:width: 70 %
:target: dcmotor.html
.. pybricks-classlink:: Motor
.. figure:: ../../api/images/pupmotors_label.png
:width: 100 %
:target: motor.html
.. pybricks-classlink:: TiltSensor
.. figure:: ../../api/images/sensor_tilt.png
:width: 35 %
:target: tiltsensor.html
.. pybricks-classlink:: InfraredSensor
.. figure:: ../../api/images/sensor_proximity.png
:width: 35 %
:target: infraredsensor.html
.. pybricks-classlink:: ColorDistanceSensor
.. figure:: ../../api/images/sensor_colordistance.png
:width: 32 %
:target: colordistancesensor.html
.. pybricks-classlink:: PFMotor
.. figure:: ../../api/images/pfmotor.png
:width: 95 %
:target: pfmotor.html
.. pybricks-classlink:: ColorSensor
.. figure:: ../../api/images/sensor_color.png
:width: 32 %
:target: colorsensor.html
.. pybricks-classlink:: UltrasonicSensor
.. figure:: ../../api/images/sensor_ultrasonic.png
:width: 37 %
:target: ultrasonicsensor.html
.. pybricks-classlink:: ForceSensor
.. figure:: ../../api/images/sensor_force.png
:width: 35 %
:target: forcesensor.html
.. pybricks-classlink:: Light
.. figure:: ../../api/images/light.png
:width: 90 %
:target: light.html
.. pybricks-classlink:: Remote
.. figure:: ../../api/images/pupremote.png
:width: 50 %
:target: remote.html