From d4404acd9a6cdea4e3dc27d38f2cee34e3763c44 Mon Sep 17 00:00:00 2001 From: brentru Date: Thu, 10 Oct 2019 15:13:34 -0400 Subject: [PATCH] satisfy sphinx! --- README.rst | 8 ++++++-- adafruit_aws_iot.py | 3 +-- docs/conf.py | 2 +- 3 files changed, 8 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index 5158a5f..dfb451d 100644 --- a/README.rst +++ b/README.rst @@ -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 `_ + (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... `_ Dependencies diff --git a/adafruit_aws_iot.py b/adafruit_aws_iot.py index ae0de65..f8ffa62 100644 --- a/adafruit_aws_iot.py +++ b/adafruit_aws_iot.py @@ -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: diff --git a/docs/conf.py b/docs/conf.py index 8a797ff..3413d63 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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)}