forked from platypush/platypush
Fixed docs issues
This commit is contained in:
parent
f720e7fc7f
commit
f147c44a8a
25 changed files with 27 additions and 141 deletions
|
|
@ -1,5 +0,0 @@
|
|||
``assistant``
|
||||
===============================
|
||||
|
||||
.. automodule:: platypush.backend.assistant
|
||||
:members:
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
``bluetooth``
|
||||
===============================
|
||||
|
||||
.. automodule:: platypush.backend.bluetooth
|
||||
:members:
|
||||
|
|
@ -1,6 +0,0 @@
|
|||
``sensor``
|
||||
============================
|
||||
|
||||
.. automodule:: platypush.backend.sensor
|
||||
:members:
|
||||
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
``stt``
|
||||
=========================
|
||||
|
||||
.. automodule:: platypush.backend.stt
|
||||
:members:
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
``weather``
|
||||
=============================
|
||||
|
||||
.. automodule:: platypush.backend.weather
|
||||
:members:
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
``assistant``
|
||||
===============================
|
||||
|
||||
.. automodule:: platypush.plugins.assistant
|
||||
:members:
|
||||
|
|
@ -1,6 +0,0 @@
|
|||
``camera``
|
||||
============================
|
||||
|
||||
.. automodule:: platypush.plugins.camera
|
||||
:members:
|
||||
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
``chat``
|
||||
========
|
||||
|
||||
.. automodule:: platypush.plugins.chat
|
||||
:members:
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
``google``
|
||||
============================
|
||||
|
||||
.. automodule:: platypush.plugins.google
|
||||
:members:
|
||||
|
||||
|
||||
|
|
@ -1,6 +0,0 @@
|
|||
``gpio.sensor``
|
||||
=================================
|
||||
|
||||
.. automodule:: platypush.plugins.gpio.sensor
|
||||
:members:
|
||||
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
``homeseer``
|
||||
==============================
|
||||
|
||||
.. automodule:: platypush.plugins.homeseer
|
||||
:members:
|
||||
|
||||
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
``lcd``
|
||||
=========================
|
||||
|
||||
.. automodule:: platypush.plugins.lcd
|
||||
:members:
|
||||
|
|
@ -1,6 +0,0 @@
|
|||
``light``
|
||||
===========================
|
||||
|
||||
.. automodule:: platypush.plugins.light
|
||||
:members:
|
||||
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
``mail``
|
||||
==========================
|
||||
|
||||
.. automodule:: platypush.plugins.mail
|
||||
:members:
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
``media``
|
||||
===========================
|
||||
|
||||
.. automodule:: platypush.plugins.media
|
||||
:members:
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
``music``
|
||||
===========================
|
||||
|
||||
.. automodule:: platypush.plugins.music
|
||||
:members:
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
``sensor``
|
||||
============================
|
||||
|
||||
.. automodule:: platypush.plugins.sensor
|
||||
:members:
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
``stt``
|
||||
=========================
|
||||
|
||||
.. automodule:: platypush.plugins.stt
|
||||
:members:
|
||||
|
|
@ -1,6 +0,0 @@
|
|||
``switch``
|
||||
============================
|
||||
|
||||
.. automodule:: platypush.plugins.switch
|
||||
:members:
|
||||
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
``weather``
|
||||
=============================
|
||||
|
||||
.. automodule:: platypush.plugins.weather
|
||||
:members:
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
``zwave._base``
|
||||
=================================
|
||||
|
||||
.. automodule:: platypush.plugins.zwave._base
|
||||
:members:
|
||||
|
|
@ -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,
|
||||
|
|
|
|||
|
|
@ -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``
|
||||
|
||||
"""
|
||||
|
||||
|
|
|
|||
|
|
@ -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``
|
||||
|
||||
"""
|
||||
|
||||
|
|
|
|||
|
|
@ -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 <https://api.slack.com/apps>`_ 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 <https://api.slack.com/apps>` 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:
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue