Skip to content

Commit ee19760

Browse files
committed
Update config files to generate documentation.
1 parent 67b9616 commit ee19760

File tree

5 files changed

+16
-6
lines changed

5 files changed

+16
-6
lines changed

README.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,8 +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
98-
examples folder and be included in docs/examples.rst.
97+
.. todo:: Add a quick, simple example. It and other examples should live in the examples folder and be included in docs/examples.rst.
9998

10099
Documentation
101100
=============

docs/api.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,12 @@
66
77
.. automodule:: i2c_expanders
88
:members:
9+
10+
.. automodule:: i2c_expanders.i2c_expander
11+
:members:
12+
13+
.. automodule:: i2c_expanders.digital_inout
14+
:members:
15+
16+
.. automodule:: i2c_expanders.PCA9555
17+
:members:

docs/conf.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,14 @@
2727
# Uncomment the below if you use native CircuitPython modules such as
2828
# digitalio, micropython and busio. List the modules you use. Without it, the
2929
# autodoc module docs will fail to generate with a warning.
30-
# autodoc_mock_imports = ["digitalio", "busio"]
30+
autodoc_mock_imports = ["digitalio", "adafruit_bus_device", "i2c_device", "micropython"]
3131

3232
autodoc_preserve_defaults = True
3333

3434

3535
intersphinx_mapping = {
36-
"python": ("https://docs.python.org/3", None),"BusDevice": ("https://docs.circuitpython.org/projects/busdevice/en/latest/", None),
37-
36+
"python": ("https://docs.python.org/3", None),
37+
"BusDevice": ("https://docs.circuitpython.org/projects/busdevice/en/latest/", None),
3838
"CircuitPython": ("https://docs.circuitpython.org/en/latest/", None),
3939
}
4040

pyproject.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,8 @@ dynamic = ["dependencies", "optional-dependencies"]
4949
[tool.setuptools]
5050
# TODO: IF LIBRARY FILES ARE A PACKAGE FOLDER,
5151
# CHANGE `py_modules = ['...']` TO `packages = ['...']`
52-
py-modules = ["i2c_expanders"]
52+
#py-modules = ["i2c_expanders"]
53+
packages = ['i2c_expanders']
5354

5455
[tool.setuptools.dynamic]
5556
dependencies = {file = ["requirements.txt"]}

requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,4 @@
55

66
Adafruit-Blinka
77
adafruit-circuitpython-busdevice
8+
micropython

0 commit comments

Comments
 (0)