From 1d3d741212a8410a5331c76b5534630fdfd035c5 Mon Sep 17 00:00:00 2001
From: Fabio Manganiello <info@fabiomanganiello.com>
Date: Sun, 14 Mar 2021 01:09:01 +0100
Subject: [PATCH] Fixed Sphinx build warnings

---
 platypush/backend/file/monitor/__init__.py | 9 +++++----
 platypush/backend/mqtt.py                  | 6 ++++++
 platypush/plugins/zigbee/mqtt.py           | 6 ++++--
 3 files changed, 15 insertions(+), 6 deletions(-)

diff --git a/platypush/backend/file/monitor/__init__.py b/platypush/backend/file/monitor/__init__.py
index 961e8451..a2718bfb 100644
--- a/platypush/backend/file/monitor/__init__.py
+++ b/platypush/backend/file/monitor/__init__.py
@@ -74,17 +74,18 @@ class FileMonitorBackend(Backend):
                     backend.file.monitor:
                         paths:
                             # Recursively monitor changes on the ~/my-images folder that include all
-                            # the files matching the "\.jpe?g$" pattern in case-insensitive mode,
+                            # the files matching a JPEG extension in case-insensitive mode,
                             # excluding those whose name starts with tmp_ and
                             # all the files contained in the __MACOSX folders
                             - path: ~/my-images
                               recursive: True
+                              case_sensitive: False
                               regexes:
-                                - ".*\.jpe?g$"
+                                - '.*\.jpe?g$'
                               ignore_patterns:
-                                - "^tmp_.*"
+                                - '^tmp_.*'
                               ignore_directories:
-                                - "__MACOSX"
+                                - '__MACOSX'
 
         """
 
diff --git a/platypush/backend/mqtt.py b/platypush/backend/mqtt.py
index cf27f942..1091ff7d 100644
--- a/platypush/backend/mqtt.py
+++ b/platypush/backend/mqtt.py
@@ -46,6 +46,9 @@ class MqttClient(mqtt.Client, threading.Thread):
         self._stop_scheduled = False
 
     def subscribe(self, *topics, **kwargs):
+        """
+        Client subscription handler.
+        """
         if not topics:
             topics = self.topics
 
@@ -54,6 +57,9 @@ class MqttClient(mqtt.Client, threading.Thread):
             super().subscribe(topic, **kwargs)
 
     def unsubscribe(self, *topics, **kwargs):
+        """
+        Client unsubscription handler.
+        """
         if not topics:
             topics = self.topics
 
diff --git a/platypush/plugins/zigbee/mqtt.py b/platypush/plugins/zigbee/mqtt.py
index ed8535eb..2ab9dd79 100644
--- a/platypush/plugins/zigbee/mqtt.py
+++ b/platypush/plugins/zigbee/mqtt.py
@@ -23,9 +23,11 @@ class ZigbeeMqttPlugin(MqttPlugin, SwitchPlugin):
     Instructions:
 
         - Install `cc-tool <https://github.com/dashesy/cc-tool>`_ either from sources or from a package manager.
-        - Connect the Zigbee to your PC/RaspberryPi in this way:
+        - Connect the Zigbee to your PC/RaspberryPi in this way: ::
+
             USB -> CC debugger -> downloader cable -> CC2531 -> USB
-          The debugger and the adapter should be connected *at the same time*. If the later ``cc-tool`` command throws
+
+        - The debugger and the adapter should be connected *at the same time*. If the later ``cc-tool`` command throws
           up an error, put the device in sync while connected by pressing the _Reset_ button on the debugger.
         - Check where the device is mapped. On Linux it will usually be ``/dev/ttyACM0``.
         - Download the latest `Z-Stack firmware <https://github.com/Koenkk/Z-Stack-firmware/tree/master/coordinator>`_