Skip to content

Commit 072f4b3

Browse files
committed
Got README.rst to render in PyPI
1 parent df87757 commit 072f4b3

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ Next, define where the bit is located in the device's memory map:
8282
world = i2c_bit.RWBit(0x1, 0x0)
8383
"""Bit to indicate if world is lit."""
8484
85-
Lastly, we need to add an ``i2c_device`` member of type :class:`~adafruit_bus_device.i2c_device.I2CDevice`
85+
Lastly, we need to add an ``i2c_device`` member of type `I2CDevice <https://circuitpython.readthedocs.io/projects/busdevice/en/latest/api.html#adafruit_bus_device.i2c_device.I2CDevice>`_
8686
that manages sharing the I2C bus for us. Make sure the name is exact, otherwise
8787
the registers will not be able to find it. Also, make sure that the i2c device
8888
implements the `busio.I2C` interface.
@@ -177,7 +177,7 @@ we must implement ``__get__`` and ``__set__``.
177177
As you can see, we have two places to get state from. First, ``self`` stores the
178178
register class members which locate the register within the device memory map.
179179
Second, ``obj`` is the driver class that uses the register class which must by
180-
definition provide a :class:`~adafruit_bus_device.i2c_device.I2CDevice` compatible
180+
definition provide a `I2CDevice <https://circuitpython.readthedocs.io/projects/busdevice/en/latest/api.html#adafruit_bus_device.i2c_device.I2CDevice>`_ compatible
181181
object as ``i2c_device``. This object does two thing for us:
182182

183183
1. Waits for the bus to free, locks it as we use it and frees it after.

0 commit comments

Comments
 (0)