jepler/Adafruit_CircuitPython_AWS_IOT
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

satisfy sphinx!

Browse source
This commit is contained in:
brentru 2019-10-10 15:13:34 -04:00
parent 8a8a65cc90
commit d4404acd9a
3 changed files with 8 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.rst
View file

@ -13,9 +13,13 @@ Introduction
:target: https://travis-ci.com/adafruit/Adafruit_CircuitPython_AWS_IOT
:alt: Build Status
Amazon AWS IoT Client for CircuitPython. Uses the AWS MQTT Client.
Amazon AWS IoT MQTT Client for CircuitPython.
.. todo:: Add note about nina-fw 1.4.0 here
**Note**: This library requires version **>=1.4.0** of the `Adafruit fork of the Arduino NINA-W102 firmware <https://github.com/adafruit/nina-fw>`_
(release version 1.4.0 or above) installed on your ESP32 Airlift/WiFi Co-Processor.
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>`_
Dependencies

3
adafruit_aws_iot.py
View file

@ -133,8 +133,7 @@ class MQTT_CLIENT:
def connect(self, clean_session=True):
"""Connects to Amazon AWS IoT MQTT Broker with Client ID.
:param bool clean_session: Establishes a persistent/clean session with
AWS IoT's MQTT broker.
:param bool clean_session: Establishes a clean session with AWS broker.
"""
try:

2
docs/conf.py
View file

@ -20,7 +20,7 @@ extensions = [
# Uncomment the below if you use native CircuitPython modules such as
# digitalio, micropython and busio. List the modules you use. Without it, the
# autodoc module docs will fail to generate with a warning.
# autodoc_mock_imports = ["digitalio", "busio"]
autodoc_mock_imports = ["adafruit_minimqtt"]
intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)}