From f147c44a8a568e4e6a66250ab0b2be42a54a0f69 Mon Sep 17 00:00:00 2001 From: Fabio Manganiello Date: Wed, 22 Sep 2021 00:19:14 +0200 Subject: [PATCH] Fixed docs issues --- docs/source/platypush/backend/assistant.rst | 5 ---- docs/source/platypush/backend/bluetooth.rst | 5 ---- docs/source/platypush/backend/sensor.rst | 6 ----- docs/source/platypush/backend/stt.rst | 5 ---- docs/source/platypush/backend/weather.rst | 5 ---- docs/source/platypush/plugins/assistant.rst | 5 ---- docs/source/platypush/plugins/camera.rst | 6 ----- docs/source/platypush/plugins/chat.rst | 5 ---- docs/source/platypush/plugins/google.rst | 7 ----- docs/source/platypush/plugins/gpio.sensor.rst | 6 ----- docs/source/platypush/plugins/homeseer.rst | 7 ----- docs/source/platypush/plugins/lcd.rst | 5 ---- docs/source/platypush/plugins/light.rst | 6 ----- docs/source/platypush/plugins/mail.rst | 5 ---- docs/source/platypush/plugins/media.rst | 5 ---- docs/source/platypush/plugins/music.rst | 5 ---- docs/source/platypush/plugins/sensor.rst | 5 ---- docs/source/platypush/plugins/stt.rst | 5 ---- docs/source/platypush/plugins/switch.rst | 6 ----- docs/source/platypush/plugins/weather.rst | 5 ---- docs/source/platypush/plugins/zwave._base.rst | 5 ---- platypush/message/response/todoist.py | 26 +++++++++---------- .../plugins/camera/gstreamer/__init__.py | 4 +-- platypush/plugins/media/gstreamer/__init__.py | 4 +-- platypush/plugins/slack/__init__.py | 20 +++++++------- 25 files changed, 27 insertions(+), 141 deletions(-) delete mode 100644 docs/source/platypush/backend/assistant.rst delete mode 100644 docs/source/platypush/backend/bluetooth.rst delete mode 100644 docs/source/platypush/backend/sensor.rst delete mode 100644 docs/source/platypush/backend/stt.rst delete mode 100644 docs/source/platypush/backend/weather.rst delete mode 100644 docs/source/platypush/plugins/assistant.rst delete mode 100644 docs/source/platypush/plugins/camera.rst delete mode 100644 docs/source/platypush/plugins/chat.rst delete mode 100644 docs/source/platypush/plugins/google.rst delete mode 100644 docs/source/platypush/plugins/gpio.sensor.rst delete mode 100644 docs/source/platypush/plugins/homeseer.rst delete mode 100644 docs/source/platypush/plugins/lcd.rst delete mode 100644 docs/source/platypush/plugins/light.rst delete mode 100644 docs/source/platypush/plugins/mail.rst delete mode 100644 docs/source/platypush/plugins/media.rst delete mode 100644 docs/source/platypush/plugins/music.rst delete mode 100644 docs/source/platypush/plugins/sensor.rst delete mode 100644 docs/source/platypush/plugins/stt.rst delete mode 100644 docs/source/platypush/plugins/switch.rst delete mode 100644 docs/source/platypush/plugins/weather.rst delete mode 100644 docs/source/platypush/plugins/zwave._base.rst diff --git a/docs/source/platypush/backend/assistant.rst b/docs/source/platypush/backend/assistant.rst deleted file mode 100644 index 635b094f..00000000 --- a/docs/source/platypush/backend/assistant.rst +++ /dev/null @@ -1,5 +0,0 @@ -``assistant`` -=============================== - -.. automodule:: platypush.backend.assistant - :members: diff --git a/docs/source/platypush/backend/bluetooth.rst b/docs/source/platypush/backend/bluetooth.rst deleted file mode 100644 index e0db369c..00000000 --- a/docs/source/platypush/backend/bluetooth.rst +++ /dev/null @@ -1,5 +0,0 @@ -``bluetooth`` -=============================== - -.. automodule:: platypush.backend.bluetooth - :members: diff --git a/docs/source/platypush/backend/sensor.rst b/docs/source/platypush/backend/sensor.rst deleted file mode 100644 index 7fe6b8ce..00000000 --- a/docs/source/platypush/backend/sensor.rst +++ /dev/null @@ -1,6 +0,0 @@ -``sensor`` -============================ - -.. automodule:: platypush.backend.sensor - :members: - diff --git a/docs/source/platypush/backend/stt.rst b/docs/source/platypush/backend/stt.rst deleted file mode 100644 index 1fe99230..00000000 --- a/docs/source/platypush/backend/stt.rst +++ /dev/null @@ -1,5 +0,0 @@ -``stt`` -========================= - -.. automodule:: platypush.backend.stt - :members: diff --git a/docs/source/platypush/backend/weather.rst b/docs/source/platypush/backend/weather.rst deleted file mode 100644 index 538ac701..00000000 --- a/docs/source/platypush/backend/weather.rst +++ /dev/null @@ -1,5 +0,0 @@ -``weather`` -============================= - -.. automodule:: platypush.backend.weather - :members: diff --git a/docs/source/platypush/plugins/assistant.rst b/docs/source/platypush/plugins/assistant.rst deleted file mode 100644 index 17993dad..00000000 --- a/docs/source/platypush/plugins/assistant.rst +++ /dev/null @@ -1,5 +0,0 @@ -``assistant`` -=============================== - -.. automodule:: platypush.plugins.assistant - :members: diff --git a/docs/source/platypush/plugins/camera.rst b/docs/source/platypush/plugins/camera.rst deleted file mode 100644 index 4714840b..00000000 --- a/docs/source/platypush/plugins/camera.rst +++ /dev/null @@ -1,6 +0,0 @@ -``camera`` -============================ - -.. automodule:: platypush.plugins.camera - :members: - diff --git a/docs/source/platypush/plugins/chat.rst b/docs/source/platypush/plugins/chat.rst deleted file mode 100644 index 621ee988..00000000 --- a/docs/source/platypush/plugins/chat.rst +++ /dev/null @@ -1,5 +0,0 @@ -``chat`` -======== - -.. automodule:: platypush.plugins.chat - :members: diff --git a/docs/source/platypush/plugins/google.rst b/docs/source/platypush/plugins/google.rst deleted file mode 100644 index 4949bb38..00000000 --- a/docs/source/platypush/plugins/google.rst +++ /dev/null @@ -1,7 +0,0 @@ -``google`` -============================ - -.. automodule:: platypush.plugins.google - :members: - - diff --git a/docs/source/platypush/plugins/gpio.sensor.rst b/docs/source/platypush/plugins/gpio.sensor.rst deleted file mode 100644 index 0478cc5c..00000000 --- a/docs/source/platypush/plugins/gpio.sensor.rst +++ /dev/null @@ -1,6 +0,0 @@ -``gpio.sensor`` -================================= - -.. automodule:: platypush.plugins.gpio.sensor - :members: - diff --git a/docs/source/platypush/plugins/homeseer.rst b/docs/source/platypush/plugins/homeseer.rst deleted file mode 100644 index 110b2134..00000000 --- a/docs/source/platypush/plugins/homeseer.rst +++ /dev/null @@ -1,7 +0,0 @@ -``homeseer`` -============================== - -.. automodule:: platypush.plugins.homeseer - :members: - - diff --git a/docs/source/platypush/plugins/lcd.rst b/docs/source/platypush/plugins/lcd.rst deleted file mode 100644 index cd15c455..00000000 --- a/docs/source/platypush/plugins/lcd.rst +++ /dev/null @@ -1,5 +0,0 @@ -``lcd`` -========================= - -.. automodule:: platypush.plugins.lcd - :members: diff --git a/docs/source/platypush/plugins/light.rst b/docs/source/platypush/plugins/light.rst deleted file mode 100644 index 4ddf3b01..00000000 --- a/docs/source/platypush/plugins/light.rst +++ /dev/null @@ -1,6 +0,0 @@ -``light`` -=========================== - -.. automodule:: platypush.plugins.light - :members: - diff --git a/docs/source/platypush/plugins/mail.rst b/docs/source/platypush/plugins/mail.rst deleted file mode 100644 index b20c5e6c..00000000 --- a/docs/source/platypush/plugins/mail.rst +++ /dev/null @@ -1,5 +0,0 @@ -``mail`` -========================== - -.. automodule:: platypush.plugins.mail - :members: diff --git a/docs/source/platypush/plugins/media.rst b/docs/source/platypush/plugins/media.rst deleted file mode 100644 index 9fe5d119..00000000 --- a/docs/source/platypush/plugins/media.rst +++ /dev/null @@ -1,5 +0,0 @@ -``media`` -=========================== - -.. automodule:: platypush.plugins.media - :members: diff --git a/docs/source/platypush/plugins/music.rst b/docs/source/platypush/plugins/music.rst deleted file mode 100644 index 8d582fa6..00000000 --- a/docs/source/platypush/plugins/music.rst +++ /dev/null @@ -1,5 +0,0 @@ -``music`` -=========================== - -.. automodule:: platypush.plugins.music - :members: diff --git a/docs/source/platypush/plugins/sensor.rst b/docs/source/platypush/plugins/sensor.rst deleted file mode 100644 index 11882a9d..00000000 --- a/docs/source/platypush/plugins/sensor.rst +++ /dev/null @@ -1,5 +0,0 @@ -``sensor`` -============================ - -.. automodule:: platypush.plugins.sensor - :members: diff --git a/docs/source/platypush/plugins/stt.rst b/docs/source/platypush/plugins/stt.rst deleted file mode 100644 index 0499b829..00000000 --- a/docs/source/platypush/plugins/stt.rst +++ /dev/null @@ -1,5 +0,0 @@ -``stt`` -========================= - -.. automodule:: platypush.plugins.stt - :members: diff --git a/docs/source/platypush/plugins/switch.rst b/docs/source/platypush/plugins/switch.rst deleted file mode 100644 index 7a2d3f40..00000000 --- a/docs/source/platypush/plugins/switch.rst +++ /dev/null @@ -1,6 +0,0 @@ -``switch`` -============================ - -.. automodule:: platypush.plugins.switch - :members: - diff --git a/docs/source/platypush/plugins/weather.rst b/docs/source/platypush/plugins/weather.rst deleted file mode 100644 index b960db0b..00000000 --- a/docs/source/platypush/plugins/weather.rst +++ /dev/null @@ -1,5 +0,0 @@ -``weather`` -============================= - -.. automodule:: platypush.plugins.weather - :members: diff --git a/docs/source/platypush/plugins/zwave._base.rst b/docs/source/platypush/plugins/zwave._base.rst deleted file mode 100644 index 5f35bf0c..00000000 --- a/docs/source/platypush/plugins/zwave._base.rst +++ /dev/null @@ -1,5 +0,0 @@ -``zwave._base`` -================================= - -.. automodule:: platypush.plugins.zwave._base - :members: diff --git a/platypush/message/response/todoist.py b/platypush/message/response/todoist.py index bcb22db9..b4def109 100644 --- a/platypush/message/response/todoist.py +++ b/platypush/message/response/todoist.py @@ -199,13 +199,13 @@ class TodoistItemsResponse(TodoistResponse): class TodoistFilter(Mapping): def __init__(self, - color: [int], - id: [int], - is_deleted: [bool], - is_favorite: [bool], - item_order: [int], - name: [str], - query: [str], + color: int, + id: int, + is_deleted: bool, + is_favorite: bool, + item_order: int, + name: str, + query: str, legacy_id: Optional[int] = None, *args, **kwargs): super().__init__(*args, **kwargs) @@ -230,12 +230,12 @@ class TodoistFiltersResponse(TodoistResponse): class TodoistLiveNotification(Mapping): def __init__(self, - id: [int], - is_deleted: [bool], - created: [str], - is_unread: [bool], - notification_key: [str], - notification_type: [str], + id: int, + is_deleted: bool, + created: str, + is_unread: bool, + notification_key: str, + notification_type: str, completed_last_month: Optional[int] = None, karma_level: Optional[int] = None, promo_img: Optional[str] = None, diff --git a/platypush/plugins/camera/gstreamer/__init__.py b/platypush/plugins/camera/gstreamer/__init__.py index 2654b9fa..14a1d5fe 100644 --- a/platypush/plugins/camera/gstreamer/__init__.py +++ b/platypush/plugins/camera/gstreamer/__init__.py @@ -18,11 +18,11 @@ class CameraGstreamerPlugin(CameraPlugin): On Debian and derived systems: - * ``[sudo] apt-get install python3-gi python3-gst-1.0 + * ``[sudo] apt-get install python3-gi python3-gst-1.0`` On Arch and derived systems: - * ``[sudo] pacman -S gst-python + * ``[sudo] pacman -S gst-python`` """ diff --git a/platypush/plugins/media/gstreamer/__init__.py b/platypush/plugins/media/gstreamer/__init__.py index fcf79fbe..557a65b7 100644 --- a/platypush/plugins/media/gstreamer/__init__.py +++ b/platypush/plugins/media/gstreamer/__init__.py @@ -18,11 +18,11 @@ class MediaGstreamerPlugin(MediaPlugin): On Debian and derived systems: - * ``[sudo] apt-get install python3-gi python3-gst-1.0 + * ``[sudo] apt-get install python3-gi python3-gst-1.0`` On Arch and derived systems: - * ``[sudo] pacman -S gst-python + * ``[sudo] pacman -S gst-python`` """ diff --git a/platypush/plugins/slack/__init__.py b/platypush/plugins/slack/__init__.py index 691ba75f..964974c0 100644 --- a/platypush/plugins/slack/__init__.py +++ b/platypush/plugins/slack/__init__.py @@ -18,22 +18,22 @@ class SlackPlugin(ChatPlugin, RunnablePlugin): You'll have to generate your own Slack app and tokens in order to use this plugin. Steps: - - Create a new Slack app `here `_ and associate a Slack workspace to it. - - In the configuration panel of your app scroll to _Socket Mode_ and select _Enable Socket Mode_. - - Scroll to _Event Subscriptions_ and select _Enable Events_. + - Create a new Slack app `here ` and associate a Slack workspace to it. + - In the configuration panel of your app scroll to Socket Mode and select Enable Socket Mode_. + - Scroll to Event Subscriptions and select Enable Events_. - Choose the type of events that you want to subscribe to. You can select bot events (i.e. when somebody in the channel mentions the name of your app) or any of the workspace events (e.g. creation of messages, user events etc.). - - Scroll to _App-Level Tokens_ and generate a new token with ``connections:write`` scope. This token will be + - Scroll to App-Level Tokens and generate a new token with ``connections:write`` scope. This token will be used to receive Slack events over websocket. - - Scroll to _OAuth & Permissions_ and select the scopes that you want to enable. You may usually want to enable - _Bot Token Scopes_ -> ``app_mentions:read``, so the script can react when somebody mentions its name. You may + - Scroll to OAuth & Permissions and select the scopes that you want to enable. You may usually want to enable + Bot Token Scopes -> ``app_mentions:read``, so the script can react when somebody mentions its name. You may also want to select the user scopes relevant to your application - e.g. read/write messages, manage users etc. - If you changed scopes and settings, you may have to reinstall the app in the workspace through the - _Install App_ menu. - - Navigate to the _Install App_ menu. If the app has been correctly installed in your workspace then you should - see a _Bot User OAuth Token_, used to authenticate API calls performed as the app/bot. If you also granted - user permissions to the app then you should also see a _User OAuth Token_ on the page. + Install App menu. + - Navigate to the Install App menu. If the app has been correctly installed in your workspace then you should + see a Bot User OAuth Token_, used to authenticate API calls performed as the app/bot. If you also granted + user permissions to the app then you should also see a User OAuth Token on the page. Triggers: