platypush/docs/source/index.rst

60 lines
1.3 KiB
ReStructuredText
Raw Normal View History

2018-06-23 01:00:43 +02:00
Platypush
#########
2023-11-01 03:11:19 +01:00
Description
===========
2018-07-09 22:56:05 +02:00
2023-11-01 03:11:19 +01:00
This is the main documentation hub for Platypush. It includes both the wiki and
the complete reference of the available integrations.
2018-07-09 22:56:05 +02:00
2023-11-01 03:11:19 +01:00
Platypush is a general-purpose automation framework that can be used to cover
all the cases where you'd use a home automation hub, a media center, a smart
assistant, some IFTTT recipes, and a variety of other products and services.
2018-07-16 22:55:24 +02:00
2023-11-01 03:11:19 +01:00
It draws inspiration from the following projects, and it aims to cover all of
their use-cases:
* `Home Assistant <https://www.home-assistant.io/>`_
* `Homebridge <https://homebridge.io/>`_
* `OpenHAB <https://www.openhab.org/>`_
* `IFTTT <https://ifttt.com/>`_
* `Tasker <https://tasker.joaoapps.com/>`_
Useful links
============
* The `main page <https://platypush.tech>`_ of the project.
* The `Gitea page <https://git.platypush.tech/platypush/platypush>`_.
* The `blog <https://blog.platypush.tech>`_, for articles showing how to use
Platypush in real-world scenarios.
Wiki
====
2018-07-09 22:56:05 +02:00
.. toctree::
:maxdepth: 3
wiki/index
wiki/Installation
wiki/Configuration
wiki/Installing-extensions
2023-11-01 03:11:19 +01:00
wiki/A-configuration-example
Reference
=========
2018-06-23 01:00:43 +02:00
.. toctree::
:maxdepth: 2
2018-06-23 01:00:43 +02:00
2018-06-26 00:16:39 +02:00
backends
2018-06-23 01:00:43 +02:00
plugins
2018-07-09 22:37:54 +02:00
events
responses
2018-06-23 01:00:43 +02:00
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`