Added documentation for response objects as well

This commit is contained in:
Fabio Manganiello 2020-03-05 17:39:50 +01:00
parent 5504048c22
commit e66c02f3de
17 changed files with 181 additions and 0 deletions

View file

@ -7,9 +7,11 @@ For more information on Platypush please check out:
* The `GitHub page`_ of the project
* The `online wiki`_ for quickstart and examples
* The `Medium stories`_ for inspiration about possible projects
.. _GitHub page: https://github.com/BlackLight/platypush
.. _online wiki: https://github.com/BlackLight/platypush/wiki
.. _Medium stories: https://medium.com/tag/platypush/archive
.. toctree::
:maxdepth: 3
@ -18,6 +20,7 @@ For more information on Platypush please check out:
backends
plugins
events
responses
Indices and tables
==================

View file

@ -0,0 +1,5 @@
``platypush.message.response.bluetooth``
========================================
.. automodule:: platypush.message.response.bluetooth
:members:

View file

@ -0,0 +1,5 @@
``platypush.message.response.camera.android``
=============================================
.. automodule:: platypush.message.response.camera.android
:members:

View file

@ -0,0 +1,5 @@
``platypush.message.response.camera``
=====================================
.. automodule:: platypush.message.response.camera
:members:

View file

@ -0,0 +1,5 @@
``platypush.message.response.chat.telegram``
============================================
.. automodule:: platypush.message.response.chat.telegram
:members:

View file

@ -0,0 +1,5 @@
``platypush.message.response.deepspeech``
=========================================
.. automodule:: platypush.message.response.deepspeech
:members:

View file

@ -0,0 +1,5 @@
``platypush.message.response.google.drive``
===========================================
.. automodule:: platypush.message.response.google.drive
:members:

View file

@ -0,0 +1,5 @@
``platypush.message.response.pihole``
=====================================
.. automodule:: platypush.message.response.pihole
:members:

View file

@ -0,0 +1,5 @@
``platypush.message.response.ping``
===================================
.. automodule:: platypush.message.response.ping
:members:

View file

@ -0,0 +1,5 @@
``platypush.message.response.printer.cups``
===========================================
.. automodule:: platypush.message.response.printer.cups
:members:

View file

@ -0,0 +1,5 @@
``platypush.message.response.system``
=====================================
.. automodule:: platypush.message.response.system
:members:

View file

@ -0,0 +1,5 @@
``platypush.message.response.todoist``
======================================
.. automodule:: platypush.message.response.todoist
:members:

View file

@ -0,0 +1,5 @@
``platypush.message.response.trello``
=====================================
.. automodule:: platypush.message.response.trello
:members:

View file

@ -0,0 +1,5 @@
``platypush.message.response.weather.buienradar``
=================================================
.. automodule:: platypush.message.response.weather.buienradar
:members:

21
docs/source/responses.rst Normal file
View file

@ -0,0 +1,21 @@
Responses
=========
.. toctree::
:maxdepth: 2
:caption: Responses:
platypush/responses/bluetooth.rst
platypush/responses/camera.rst
platypush/responses/camera.android.rst
platypush/responses/chat.telegram.rst
platypush/responses/deepspeech.rst
platypush/responses/google.drive.rst
platypush/responses/pihole.rst
platypush/responses/ping.rst
platypush/responses/printer.cups.rst
platypush/responses/system.rst
platypush/responses/todoist.rst
platypush/responses/trello.rst
platypush/responses/weather.buienradar.rst