Add docs links to brickpi3 sensor example

WasabiFan · WasabiFan · commit a56da3fdcb97 · 2020-03-22T18:10:12.000-07:00
diff --git a/docs/ports.rst b/docs/ports.rst
@@ -2,7 +2,8 @@ Lego Port
 =========
 
 The `LegoPort` class is only needed when manually reconfiguring input/output
-ports. Most users can ignore this page.
+ports. This is necessary on the BrickPi but not other platforms, such as the
+EV3. Most users can ignore this page.
 
 .. autoclass:: ev3dev2.port.LegoPort
     :members:
diff --git a/docs/sensors.rst b/docs/sensors.rst
@@ -3,6 +3,11 @@ Sensor classes
 
 .. contents:: :local:
 
+*Note:* If you are using a BrickPi rather than an EV3, you will need to manually
+configure the ports before interacting with your sensors. See the example
+`here <https://github.com/ev3dev/ev3dev-lang-python-demo/blob/stretch/platform/brickpi3-motor-and-sensor.py>`_.
+
+
 Dedicated sensor classes
 ------------------------
 
diff --git a/ev3dev2/port.py b/ev3dev2/port.py
@@ -38,6 +38,9 @@ class LegoPort(Device):
     the LEGO MINDSTORMS EV3 Intelligent Brick, the LEGO WeDo USB hub and
     various sensor multiplexers from 3rd party manufacturers.
 
+    See the following example for using this class to configure sensors:
+    https://github.com/ev3dev/ev3dev-lang-python-demo/blob/stretch/platform/brickpi3-motor-and-sensor.py
+
     Some types of ports may have multiple modes of operation. For example, the
     input ports on the EV3 brick can communicate with sensors using UART, I2C
     or analog validate signals - but not all at the same time. Therefore there
