Skip to content

Commit c789ca0

Browse files
committed
fix docs build
1 parent db9a0d6 commit c789ca0

File tree

3 files changed

+9
-2
lines changed

3 files changed

+9
-2
lines changed

adafruit_bme680.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -601,7 +601,7 @@ class Adafruit_BME680_I2C(Adafruit_BME680):
601601
import board
602602
import adafruit_bme680
603603
604-
Once this is done you can define your `board.I2C` object and define your sensor object
604+
Once this is done you can define your ``board.I2C`` object and define your sensor object
605605
606606
.. code-block:: python
607607
@@ -688,7 +688,7 @@ class Adafruit_BME680_SPI(Adafruit_BME680):
688688
from digitalio import DigitalInOut, Direction
689689
import adafruit_bme680
690690
691-
Once this is done you can define your `board.SPI` object and define your sensor object
691+
Once this is done you can define your ``board.SPI`` object and define your sensor object
692692
693693
.. code-block:: python
694694

docs/conf.py

+6
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,12 @@
2020
"sphinx.ext.viewcode",
2121
]
2222

23+
# Uncomment the below if you use native CircuitPython modules such as
24+
# digitalio, micropython and busio. List the modules you use. Without it, the
25+
# autodoc module docs will fail to generate with a warning.
26+
autodoc_mock_imports = ["micropython"]
27+
28+
2329
intersphinx_mapping = {
2430
"python": ("https://docs.python.org/3", None),
2531
"BusDevice": (

docs/requirements.txt

+1
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,4 @@
55
sphinx
66
sphinxcontrib-jquery
77
sphinx-rtd-theme
8+
adafruit-circuitpython-typing

0 commit comments

Comments
 (0)