api doc's param & code-block display correctly

Author: 2bndy5

adafruit_minimqtt/adafruit_minimqtt.py

@@ -91,9 +91,9 @@ class MMQTTException(Exception):
 
 def set_socket(sock, iface=None):
     """Helper to set the global socket and optionally set the global network interface.
+
     :param sock: socket object.
     :param iface: internet interface object
-
     """
     global _the_sock  # pylint: disable=invalid-name, global-statement
     _the_sock = sock
@@ -105,6 +105,7 @@ def set_socket(sock, iface=None):
 
 class MQTT:
     """MQTT Client for CircuitPython
+
     :param str broker: MQTT Broker URL or IP Address.
     :param int port: Optional port definition, defaults to 8883.
     :param str username: Username for broker authentication.
@@ -114,7 +115,6 @@ class MQTT:
     :param bool is_ssl: Sets a secure or insecure connection with the broker.
     :param bool log: Attaches a logger to the MQTT client, defaults to logging level INFO.
     :param int keep_alive: KeepAlive interval between the broker and the MiniMQTT client.
-
     """
 
     # pylint: disable=too-many-arguments,too-many-instance-attributes, not-callable, invalid-name, no-member
@@ -201,11 +201,11 @@ def deinit(self):
 
     def will_set(self, topic=None, payload=None, qos=0, retain=False):
         """Sets the last will and testament properties. MUST be called before connect().
+
         :param str topic: MQTT Broker topic.
         :param str payload: Last will disconnection payload.
         :param int qos: Quality of Service level.
         :param bool retain: Specifies if the payload is to be retained when it is published.
-
         """
         if self.logger is not None:
             self.logger.debug("Setting last will properties")
@@ -225,18 +225,18 @@ def will_set(self, topic=None, payload=None, qos=0, retain=False):
 
     def add_topic_callback(self, mqtt_topic, callback_method):
         """Registers a callback_method for a specific MQTT topic.
+
         :param str mqtt_topic: MQTT topic.
         :param str callback_method: Name of callback method.
-
         """
         if mqtt_topic is None or callback_method is None:
             raise ValueError("MQTT topic and callback method must both be defined.")
         self._on_message_filtered[mqtt_topic] = callback_method
 
     def remove_topic_callback(self, mqtt_topic):
         """Removes a registered callback method.
-        :param str mqtt_topic: MQTT topic.
 
+        :param str mqtt_topic: MQTT topic.
         """
         if mqtt_topic is None:
             raise ValueError("MQTT Topic must be defined.")
@@ -271,8 +271,8 @@ def _handle_on_message(self, client, topic, message):
     # pylint: disable=too-many-branches, too-many-statements, too-many-locals
     def connect(self, clean_session=True):
         """Initiates connection with the MQTT Broker.
-        :param bool clean_session: Establishes a persistent session.
 
+        :param bool clean_session: Establishes a persistent session.
         """
         self._sock = _the_sock.socket()
         self._sock.settimeout(15)
@@ -411,6 +411,7 @@ def ping(self):
     # pylint: disable=too-many-branches, too-many-statements
     def publish(self, topic, msg, retain=False, qos=0):
         """Publishes a message to a topic provided.
+
         :param str topic: Unique topic identifier.
         :param str msg: Data to send to the broker.
         :param int msg: Data to send to the broker.
@@ -419,16 +420,19 @@ def publish(self, topic, msg, retain=False, qos=0):
         :param int qos: Quality of Service level for the message.
 
         Example of sending an integer, 3, to the broker on topic 'piVal'.
+
         .. code-block:: python
 
             mqtt_client.publish('topics/piVal', 3)
 
         Example of sending a float, 3.14, to the broker on topic 'piVal'.
+
         .. code-block:: python
 
             mqtt_client.publish('topics/piVal', 3.14)
 
         Example of sending a string, 'threepointonefour', to the broker on topic piVal.
+
         .. code-block:: python
 
             mqtt_client.publish('topics/piVal', 'threepointonefour')
@@ -509,27 +513,32 @@ def publish(self, topic, msg, retain=False, qos=0):
     def subscribe(self, topic, qos=0):
         """Subscribes to a topic on the MQTT Broker.
         This method can subscribe to one topics or multiple topics.
+
         :param str topic: Unique MQTT topic identifier.
         :param int qos: Quality of Service level for the topic, defaults to zero.
         :param tuple topic: Tuple containing topic identifier strings and qos level integers.
         :param list topic: List of tuples containing topic identifier strings and qos.
 
         Example of subscribing a topic string.
+
         .. code-block:: python
 
             mqtt_client.subscribe('topics/ledState')
 
         Example of subscribing to a topic and setting the qos level to 1.
+
         .. code-block:: python
 
             mqtt_client.subscribe('topics/ledState', 1)
 
         Example of subscribing to topic string and setting qos level to 1, as a tuple.
+
         .. code-block:: python
 
             mqtt_client.subscribe(('topics/ledState', 1))
 
         Example of subscribing to multiple topics with different qos levels.
+
         .. code-block:: python
 
             mqtt_client.subscribe([('topics/ledState', 1), ('topics/servoAngle', 0)])
@@ -583,15 +592,18 @@ def subscribe(self, topic, qos=0):
 
     def unsubscribe(self, topic):
         """Unsubscribes from a MQTT topic.
+
         :param str topic: Unique MQTT topic identifier.
         :param list topic: List of tuples containing topic identifier strings.
 
         Example of unsubscribing from a topic string.
+
         .. code-block:: python
 
             mqtt_client.unsubscribe('topics/ledState')
 
         Example of unsubscribing from multiple topics.
+
         .. code-block:: python
 
             mqtt_client.unsubscribe([('topics/ledState'), ('topics/servoAngle')])
@@ -645,6 +657,7 @@ def unsubscribe(self, topic):
 
     def reconnect(self, resub_topics=True):
         """Attempts to reconnect to the MQTT broker.
+
         :param bool resub_topics: Resubscribe to previously subscribed topics.
         """
         if self.logger is not None:
@@ -672,7 +685,6 @@ def loop_forever(self):
         next major release. Please see examples/minimqtt_pub_sub_blocking.py
         for an example of creating a blocking loop which can handle wireless
         network events.
-
         """
         while True:
             if self._sock.connected:
@@ -681,7 +693,6 @@ def loop_forever(self):
     def loop(self):
         """Non-blocking message loop. Use this method to
         check incoming subscription messages.
-
         """
         if self._timestamp == 0:
             self._timestamp = time.monotonic()
@@ -744,6 +755,7 @@ def _recv_len(self):
 
     def _send_str(self, string):
         """Packs and encodes a string to a socket.
+
         :param str string: String to write to the socket.
         """
         self._sock.send(struct.pack("!H", len(string)))
@@ -755,6 +767,7 @@ def _send_str(self, string):
     @staticmethod
     def _check_topic(topic):
         """Checks if topic provided is a valid mqtt topic.
+
         :param str topic: Topic identifier
         """
         if topic is None:
@@ -769,6 +782,7 @@ def _check_topic(topic):
     @staticmethod
     def _check_qos(qos_level):
         """Validates the quality of service level.
+
         :param int qos_level: Desired QoS level.
         """
         if isinstance(qos_level, int):
@@ -803,6 +817,7 @@ def mqtt_msg(self):
     @mqtt_msg.setter
     def mqtt_msg(self, msg_size):
         """Sets the maximum MQTT message payload size.
+
         :param int msg_size: Maximum MQTT payload size.
         """
         if msg_size < MQTT_MSG_MAX_SZ:
@@ -811,13 +826,15 @@ def mqtt_msg(self, msg_size):
     ### Logging ###
     def attach_logger(self, logger_name="log"):
         """Initializes and attaches a logger to the MQTTClient.
+
         :param str logger_name: Name of the logger instance
         """
         self.logger = logging.getLogger(logger_name)
         self.logger.setLevel(logging.INFO)
 
     def set_logger_level(self, log_level):
         """Sets the level of the logger, if defined during init.
+
         :param string log_level: Level of logging to output to the REPL.
         """
         if self.logger is None: