Added documentation to events

This commit is contained in:
Fabio Manganiello 2018-07-09 22:37:54 +02:00
parent 0288f7ee1b
commit b94ec36d0f
41 changed files with 554 additions and 19 deletions

28
docs/source/events.rst Normal file
View file

@ -0,0 +1,28 @@
Events
======
.. toctree::
:maxdepth: 2
:caption: Events:
platypush/events/assistant.rst
platypush/events/button.flic.rst
platypush/events/geo.rst
platypush/events/http.rst
platypush/events/http.rss.rst
platypush/events/midi.rst
platypush/events/music.rst
platypush/events/path.rst
platypush/events/ping.rst
platypush/events/pushbullet.rst
platypush/events/scard.rst
platypush/events/sensor.rst
platypush/events/sensor.ir.rst
platypush/events/sensor.leap.rst
platypush/events/sensor.light.rst
platypush/events/serial.rst
platypush/events/video.rst
platypush/events/weather.rst
platypush/events/web.rst
platypush/events/web.widget.rst

View file

@ -7,6 +7,7 @@ Platypush
backends
plugins
events
Indices and tables
==================

View file

@ -0,0 +1,6 @@
``platypush.message.event.assistant``
=====================================
.. automodule:: platypush.message.event.assistant
:members:

View file

@ -0,0 +1,6 @@
``platypush.message.event.button.flic``
=======================================
.. automodule:: platypush.message.event.button.flic
:members:

View file

@ -0,0 +1,6 @@
``platypush.message.event.geo``
===============================
.. automodule:: platypush.message.event.geo
:members:

View file

@ -0,0 +1,6 @@
``platypush.message.event.http.rss``
====================================
.. automodule:: platypush.message.event.http.rss
:members:

View file

@ -0,0 +1,6 @@
``platypush.message.event.http``
================================
.. automodule:: platypush.message.event.http
:members:

View file

@ -0,0 +1,6 @@
``platypush.message.event.midi``
================================
.. automodule:: platypush.message.event.midi
:members:

View file

@ -0,0 +1,6 @@
``platypush.message.event.music``
=================================
.. automodule:: platypush.message.event.music
:members:

View file

@ -0,0 +1,6 @@
``platypush.message.event.path``
================================
.. automodule:: platypush.message.event.path
:members:

View file

@ -0,0 +1,6 @@
``platypush.message.event.ping``
================================
.. automodule:: platypush.message.event.ping
:members:

View file

@ -0,0 +1,6 @@
``platypush.message.event.pushbullet``
======================================
.. automodule:: platypush.message.event.pushbullet
:members:

View file

@ -0,0 +1,6 @@
``platypush.message.event.scard``
=================================
.. automodule:: platypush.message.event.scard
:members:

View file

@ -0,0 +1,6 @@
``platypush.message.event.sensor.ir``
=====================================
.. automodule:: platypush.message.event.sensor.ir
:members:

View file

@ -0,0 +1,6 @@
``platypush.message.event.sensor.leap``
=======================================
.. automodule:: platypush.message.event.sensor.leap
:members:

View file

@ -0,0 +1,6 @@
``platypush.message.event.sensor.light``
========================================
.. automodule:: platypush.message.event.sensor.light
:members:

View file

@ -0,0 +1,6 @@
``platypush.message.event.sensor``
==================================
.. automodule:: platypush.message.event.sensor
:members:

View file

@ -0,0 +1,6 @@
``platypush.message.event.serial``
==================================
.. automodule:: platypush.message.event.serial
:members:

View file

@ -0,0 +1,6 @@
``platypush.message.event.video``
=================================
.. automodule:: platypush.message.event.video
:members:

View file

@ -0,0 +1,6 @@
``platypush.message.event.weather``
===================================
.. automodule:: platypush.message.event.weather
:members:

View file

@ -0,0 +1,6 @@
``platypush.message.event.web``
===============================
.. automodule:: platypush.message.event.web
:members:

View file

@ -0,0 +1,6 @@
``platypush.message.event.web.widget``
======================================
.. automodule:: platypush.message.event.web.widget
:members: