Skip to content

Commit d4404ac

Browse files
brentrubrentru
authored andcommitted
satisfy sphinx!
1 parent 8a8a65c commit d4404ac

File tree

3 files changed

+8
-5
lines changed

3 files changed

+8
-5
lines changed

README.rst

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,13 @@ Introduction
1313
:target: https://travis-ci.com/adafruit/Adafruit_CircuitPython_AWS_IOT
1414
:alt: Build Status
1515

16-
Amazon AWS IoT Client for CircuitPython. Uses the AWS MQTT Client.
16+
Amazon AWS IoT MQTT Client for CircuitPython.
1717

18-
.. todo:: Add note about nina-fw 1.4.0 here
18+
19+
**Note**: This library requires version **>=1.4.0** of the `Adafruit fork of the Arduino NINA-W102 firmware <https://github.com/adafruit/nina-fw>`_
20+
(release version 1.4.0 or above) installed on your ESP32 Airlift/WiFi Co-Processor.
21+
22+
If you do not know how to do this, `visit the Adafruit Learning System guide for this topic... <https://learn.adafruit.com/upgrading-esp32-firmware>`_
1923

2024

2125
Dependencies

adafruit_aws_iot.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -133,8 +133,7 @@ def disconnect(self):
133133

134134
def connect(self, clean_session=True):
135135
"""Connects to Amazon AWS IoT MQTT Broker with Client ID.
136-
:param bool clean_session: Establishes a persistent/clean session with
137-
AWS IoT's MQTT broker.
136+
:param bool clean_session: Establishes a clean session with AWS broker.
138137
139138
"""
140139
try:

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
# Uncomment the below if you use native CircuitPython modules such as
2121
# digitalio, micropython and busio. List the modules you use. Without it, the
2222
# autodoc module docs will fail to generate with a warning.
23-
# autodoc_mock_imports = ["digitalio", "busio"]
23+
autodoc_mock_imports = ["adafruit_minimqtt"]
2424

2525

2626
intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)}

0 commit comments

Comments
 (0)