Skip to content

Commit 7e42b44

Browse files
committed
Fix errors with Sphinx
1 parent 34ea1f8 commit 7e42b44

File tree

4 files changed

+18
-15
lines changed

4 files changed

+18
-15
lines changed

README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Installing from PyPI
4343
.. note:: This library is not available on PyPI yet. Install documentation is included
4444
as a standard element. Stay tuned for PyPI availability!
4545

46-
.. todo:: Remove the above note if PyPI version is/will be available at time of release.
46+
.. note:: TODO: Remove the above note if PyPI version is/will be available at time of release.
4747

4848
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
4949
PyPI <https://pypi.org/project/circuitpython-i2c-expanders/>`_.
@@ -94,7 +94,7 @@ Or the following command to update an existing version:
9494
Usage Example
9595
=============
9696

97-
.. todo:: Add a quick, simple example. It and other examples should live in the examples folder and be included in docs/examples.rst.
97+
.. note:: TODO: Add a quick, simple example. It and other examples should live in the examples folder and be included in docs/examples.rst.
9898

9999
Documentation
100100
=============

docs/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,13 @@ Table of Contents
2424
.. toctree::
2525
:caption: Tutorials
2626

27-
.. todo:: Add any Learn guide links here. If there are none, then simply delete this todo and leave
27+
.. note:: TODO: Add any Learn guide links here. If there are none, then simply delete this todo and leave
2828
the toctree above for use later.
2929

3030
.. toctree::
3131
:caption: Related Products
3232

33-
.. todo:: Add any product links here. If there are none, then simply delete this todo and leave
33+
.. note:: TODO: Add any product links here. If there are none, then simply delete this todo and leave
3434
the toctree above for use later.
3535

3636
.. toctree::

i2c_expanders/PCA9555.py

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,23 @@
44
#
55
# SPDX-License-Identifier: MIT
66

7+
78
# pylint: disable=too-many-public-methods
89

910
"""
10-
`pca9555`
11+
`PCA9555`
1112
====================================================
1213
1314
CircuitPython module for the PCA9555 and compatible expanders.
1415
The PCA9555 is a basic 16 pin I2C expander.
15-
*Configurable pins as input or output
16-
*Per pin polarity inversion. This inverts the value that is returned when an input port
17-
is read. Does not affect the pins set as outputs.
18-
*Pin change interrupts. An interrupt is generated on any pin change for a pin configured
19-
as an input. The interrupt signal is cleared by a change back to the original value of
20-
the input pin or a read to the GPIO register.This will have to be detected and tracked in
21-
user code. There is no way to tell from the device what pin caused the interrupt.
16+
17+
* Configurable pins as input or output
18+
* Per pin polarity inversion. This inverts the value that is returned when an input port
19+
is read. Does not affect the pins set as outputs.
20+
* Pin change interrupts. An interrupt is generated on any pin change for a pin configured
21+
as an input. The interrupt signal is cleared by a change back to the original value of
22+
the input pin or a read to the GPIO register.This will have to be detected and tracked in
23+
user code. There is no way to tell from the device what pin caused the interrupt.
2224
2325
Use this class if you are using a PCA9555 or compatible expander. This class is also used
2426
as the base class for the PCAL9555 expander.
@@ -28,8 +30,9 @@
2830
supported. A list of other devices that should be compatible is below.
2931
3032
Compatible Devices
31-
*PCA9555
32-
*TODO
33+
34+
* PCA9555
35+
* TODO
3336
3437
Heavily based on the code written by Tony DiCola for the MCP230xx library.
3538

i2c_expanders/i2c_expander.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
# SPDX-License-Identifier: MIT
55

66
"""
7-
`i2c_expander`
7+
i2c_expander.py
88
====================================================
99
1010
The base class for the I2C expanders.

0 commit comments

Comments
 (0)