Refactored documentation and changed theme

29-generic-entities-support
Fabio Manganiello 2 years ago
parent db8ea33b68
commit f250681a78

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.1 KiB

@ -32,7 +32,7 @@ class SchemaDirective(Directive):
schema_module_name = '.'.join(['platypush.schemas', *(m.group(1).split('.')[:-1])])
schema_module = importlib.import_module(schema_module_name)
schema_class = getattr(schema_module, m.group(1).split('.')[-1])
schema_args = eval(f'dict({m.group(3)})')
schema_args = eval(f'dict({m.group(3)})') if m.group(3) else {}
schema = schema_class(**schema_args)
output = {
name: self._get_field_value(field)

@ -44,7 +44,7 @@ Backends
platypush/backend/music.mopidy.rst
platypush/backend/music.mpd.rst
platypush/backend/music.snapcast.rst
platypush/backend/music.spotify.connect.rst
platypush/backend/music.spotify.rst
platypush/backend/nextcloud.rst
platypush/backend/nfc.rst
platypush/backend/nodered.rst

@ -89,8 +89,11 @@ pygments_style = 'sphinx'
#
# html_theme = 'haiku'
# html_theme = 'sphinx_rtd_theme'
html_theme = 'sphinx_material'
html_theme = 'sphinx_book_theme'
html_title = 'Platypush Documentation'
html_logo = '../../assets/logo-64.png'
html_favicon = '../../platypush/backend/http/webapp/public/favicon.ico'
html_domain_indices = True
# Theme options are theme-specific and customize the look and feel of a theme
@ -98,50 +101,12 @@ html_domain_indices = True
# documentation.
#
html_theme_options = {
'nav_title': 'Platypush documentation',
'repo_url': 'https://git.platypush.tech/platypush/platypush',
'repo_name': 'Source code',
'repo_type': 'gitlab',
'color_primary': 'green',
'color_accent': 'light-green',
'logo_icon': '&#128366',
'nav_links': [
{
'href': 'https://platypush.tech/',
'title': 'Homepage',
'internal': False,
},
{
'href': 'https://blog.platypush.tech/',
'title': 'Blog',
'internal': False,
},
{
'href': 'https://git.platypush.tech/platypush/platypush',
'title': 'Repository',
'internal': False,
},
{
'href': 'https://git.platypush.tech/platypush/platypush/-/wikis/home',
'title': 'Wiki',
'internal': False,
},
{
'href': 'https://chrome.google.com/webstore/detail/platypush/aphldjclndofhflbbdnmpejbjgomkbie',
'title': 'Chrome Extension',
'internal': False,
},
{
'href': 'https://addons.mozilla.org/en-US/firefox/addon/platypush/',
'title': 'Firefox Extension',
'internal': False,
},
{
'href': 'https://f-droid.org/en/packages/tech.platypush.platypush/',
'title': 'Android App',
'internal': False,
},
],
'toc_title': 'Platypush documentation',
'repository_url': 'https://git.platypush.tech/platypush/platypush',
'use_repository_button': True,
'use_issues_button': True,
'use_fullscreen_button': True,
'home_page_in_toc': True,
}
# Add any paths that contain custom static files (such as style sheets) here,
@ -157,9 +122,9 @@ html_theme_options = {
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
# 'searchbox.html']``.
#
html_sidebars = {
'**': ['logo-text.html', 'globaltoc.html', 'localtoc.html', 'searchbox.html']
}
# html_sidebars = {
# '**': ['logo-text.html', 'globaltoc.html', 'localtoc.html', 'searchbox.html']
# }
# -- Options for HTMLHelp output ---------------------------------------------

@ -3,12 +3,14 @@ Platypush
Welcome to the Platypush reference of available plugins, backends and event types.
For more information on Platypush please check out:
For more information on Platypush check out:
* The `main page`_ of the project
* The `Gitlab page`_ of the project
* The `online wiki`_ for quickstart and examples
* The `Blog articles`_ for inspiration on use-cases possible projects
.. _main page: https://platypush.tech
.. _Gitlab page: https://git.platypush.tech/platypush/platypush
.. _online wiki: https://git.platypush.tech/platypush/platypush/-/wikis/home
.. _Blog articles: https://blog.platypush.tech
@ -28,4 +30,3 @@ Indices and tables
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

@ -1,4 +1,4 @@
``platypush.backend.adafruit.io``
``adafruit.io``
=================================
.. automodule:: platypush.backend.adafruit.io

@ -1,4 +1,4 @@
``platypush.backend.alarm``
``alarm``
===========================
.. automodule:: platypush.backend.alarm

@ -1,4 +1,4 @@
``platypush.backend.assistant.google``
``assistant.google``
======================================
.. automodule:: platypush.backend.assistant.google

@ -1,4 +1,4 @@
``platypush.backend.assistant``
``assistant``
===============================
.. automodule:: platypush.backend.assistant

@ -1,4 +1,4 @@
``platypush.backend.assistant.snowboy``
``assistant.snowboy``
=======================================
.. automodule:: platypush.backend.assistant.snowboy

@ -1,4 +1,4 @@
``platypush.backend.bluetooth.fileserver``
``bluetooth.fileserver``
==========================================
.. automodule:: platypush.backend.bluetooth.fileserver

@ -1,4 +1,4 @@
``platypush.backend.bluetooth.pushserver``
``bluetooth.pushserver``
==========================================
.. automodule:: platypush.backend.bluetooth.pushserver

@ -1,4 +1,4 @@
``platypush.backend.bluetooth``
``bluetooth``
===============================
.. automodule:: platypush.backend.bluetooth

@ -1,4 +1,4 @@
``platypush.backend.bluetooth.scanner.ble``
``bluetooth.scanner.ble``
===========================================
.. automodule:: platypush.backend.bluetooth.scanner.ble

@ -1,4 +1,4 @@
``platypush.backend.bluetooth.scanner``
``bluetooth.scanner``
=======================================
.. automodule:: platypush.backend.bluetooth.scanner

@ -1,4 +1,4 @@
``platypush.backend.button.flic``
``button.flic``
=================================
.. automodule:: platypush.backend.button.flic

@ -1,4 +1,4 @@
``platypush.backend.camera.pi``
``camera.pi``
===============================
.. automodule:: platypush.backend.camera.pi

@ -1,4 +1,4 @@
``platypush.backend.chat.telegram``
``chat.telegram``
===================================
.. automodule:: platypush.backend.chat.telegram

@ -1,4 +1,4 @@
``platypush.backend.clipboard``
``clipboard``
===============================
.. automodule:: platypush.backend.clipboard

@ -1,4 +1,4 @@
``platypush.backend.covid19``
``covid19``
=============================
.. automodule:: platypush.backend.covid19

@ -1,4 +1,4 @@
``platypush.backend.dbus``
``dbus``
==========================
.. automodule:: platypush.backend.dbus

@ -1,4 +1,4 @@
``platypush.backend.file.monitor``
``file.monitor``
==================================
.. automodule:: platypush.backend.file.monitor

@ -1,4 +1,4 @@
``platypush.backend.foursquare``
``foursquare``
================================
.. automodule:: platypush.backend.foursquare

@ -1,4 +1,4 @@
``platypush.backend.github``
``github``
============================
.. automodule:: platypush.backend.github

@ -1,4 +1,4 @@
``platypush.backend.google.fit``
``google.fit``
================================
.. automodule:: platypush.backend.google.fit

@ -1,4 +1,4 @@
``platypush.backend.google.pubsub``
``google.pubsub``
===================================
.. automodule:: platypush.backend.google.pubsub

@ -1,4 +1,4 @@
``platypush.backend.gps``
``gps``
=========================
.. automodule:: platypush.backend.gps

@ -1,4 +1,4 @@
``platypush.backend.http.poll``
``http.poll``
===============================
.. automodule:: platypush.backend.http.poll

@ -1,4 +1,4 @@
``platypush.backend.http``
``http``
==========================
.. automodule:: platypush.backend.http

@ -1,4 +1,4 @@
``platypush.backend.inotify``
``inotify``
=============================
.. automodule:: platypush.backend.inotify

@ -1,4 +1,4 @@
``platypush.backend.joystick.jstest``
``joystick.jstest``
=====================================
.. automodule:: platypush.backend.joystick.jstest

@ -1,4 +1,4 @@
``platypush.backend.joystick.linux``
``joystick.linux``
====================================
.. automodule:: platypush.backend.joystick.linux

@ -1,4 +1,4 @@
``platypush.backend.joystick``
``joystick``
==============================
.. automodule:: platypush.backend.joystick

@ -1,4 +1,4 @@
``platypush.backend.kafka``
``kafka``
===========================
.. automodule:: platypush.backend.kafka

@ -1,4 +1,4 @@
``platypush.backend.light.hue``
``light.hue``
===============================
.. automodule:: platypush.backend.light.hue

@ -1,4 +1,4 @@
``platypush.backend.linode``
``linode``
============================
.. automodule:: platypush.backend.linode

@ -1,4 +1,4 @@
``platypush.backend.log.http``
``log.http``
==============================
.. automodule:: platypush.backend.log.http

@ -1,4 +1,4 @@
``platypush.backend.mail``
``mail``
==========================
.. automodule:: platypush.backend.mail

@ -1,4 +1,4 @@
``platypush.backend.midi``
``midi``
==========================
.. automodule:: platypush.backend.midi

@ -1,4 +1,4 @@
``platypush.backend.mqtt``
``mqtt``
==========================
.. automodule:: platypush.backend.mqtt

@ -1,4 +1,4 @@
``platypush.backend.music.mopidy``
``music.mopidy``
==================================
.. automodule:: platypush.backend.music.mopidy

@ -1,4 +1,4 @@
``platypush.backend.music.mpd``
``music.mpd``
===============================
.. automodule:: platypush.backend.music.mpd

@ -1,4 +1,4 @@
``platypush.backend.music.snapcast``
``music.snapcast``
====================================
.. automodule:: platypush.backend.music.snapcast

@ -1,5 +0,0 @@
``platypush.backend.music.spotify.connect``
===========================================
.. automodule:: platypush.backend.music.spotify.connect
:members:

@ -0,0 +1,5 @@
``music.spotify``
===================================
.. automodule:: platypush.backend.music.spotify
:members:

@ -1,4 +1,4 @@
``platypush.backend.nextcloud``
``nextcloud``
===============================
.. automodule:: platypush.backend.nextcloud

@ -1,4 +1,4 @@
``platypush.backend.nfc``
``nfc``
=========================
.. automodule:: platypush.backend.nfc

@ -1,4 +1,4 @@
``platypush.backend.nodered``
``nodered``
=============================
.. automodule:: platypush.backend.nodered

@ -1,4 +1,4 @@
``platypush.backend.ping``
``ping``
==========================
.. automodule:: platypush.backend.ping

@ -1,4 +1,4 @@
``platypush.backend.pushbullet``
``pushbullet``
================================
.. automodule:: platypush.backend.pushbullet

@ -1,4 +1,4 @@
``platypush.backend.redis``
``redis``
===========================
.. automodule:: platypush.backend.redis

@ -1,4 +1,4 @@
``platypush.backend.scard``
``scard``
===========================
.. automodule:: platypush.backend.scard

@ -1,4 +1,4 @@
``platypush.backend.sensor.accelerometer``
``sensor.accelerometer``
==========================================
.. automodule:: platypush.backend.sensor.accelerometer

@ -1,4 +1,4 @@
``platypush.backend.sensor.arduino``
``sensor.arduino``
====================================
.. automodule:: platypush.backend.sensor.arduino

@ -1,4 +1,4 @@
``platypush.backend.sensor.battery``
``sensor.battery``
====================================
.. automodule:: platypush.backend.sensor.battery

@ -1,4 +1,4 @@
``platypush.backend.sensor.bme280``
``sensor.bme280``
===================================
.. automodule:: platypush.backend.sensor.bme280

@ -1,4 +1,4 @@
``platypush.backend.sensor.dht``
``sensor.dht``
================================
.. automodule:: platypush.backend.sensor.dht

@ -1,4 +1,4 @@
``platypush.backend.sensor.distance``
``sensor.distance``
=====================================
.. automodule:: platypush.backend.sensor.distance

@ -1,4 +1,4 @@
``platypush.backend.sensor.distance.vl53l1x``
``sensor.distance.vl53l1x``
=============================================
.. automodule:: platypush.backend.sensor.distance.vl53l1x

@ -1,4 +1,4 @@
``platypush.backend.sensor.envirophat``
``sensor.envirophat``
=======================================
.. automodule:: platypush.backend.sensor.envirophat

@ -1,4 +1,4 @@
``platypush.backend.sensor.ir.zeroborg``
``sensor.ir.zeroborg``
========================================
.. automodule:: platypush.backend.sensor.ir.zeroborg

@ -1,4 +1,4 @@
``platypush.backend.sensor.leap``
``sensor.leap``
=================================
.. automodule:: platypush.backend.sensor.leap

@ -1,4 +1,4 @@
``platypush.backend.sensor.ltr559``
``sensor.ltr559``
===================================
.. automodule:: platypush.backend.sensor.ltr559

@ -1,4 +1,4 @@
``platypush.backend.sensor.mcp3008``
``sensor.mcp3008``
====================================
.. automodule:: platypush.backend.sensor.mcp3008

@ -1,4 +1,4 @@
``platypush.backend.sensor.motion.pwm3901``
``sensor.motion.pwm3901``
===========================================
.. automodule:: platypush.backend.sensor.motion.pwm3901

@ -1,4 +1,4 @@
``platypush.backend.sensor``
``sensor``
============================
.. automodule:: platypush.backend.sensor

@ -1,4 +1,4 @@
``platypush.backend.sensor.serial``
``sensor.serial``
===================================
.. automodule:: platypush.backend.sensor.serial

@ -1,4 +1,4 @@
``platypush.backend.stt.deepspeech``
``stt.deepspeech``
====================================
.. automodule:: platypush.backend.stt.deepspeech

@ -1,4 +1,4 @@
``platypush.backend.stt.picovoice.hotword``
``stt.picovoice.hotword``
===========================================
.. automodule:: platypush.backend.stt.picovoice.hotword

@ -1,4 +1,4 @@
``platypush.backend.stt.picovoice.speech``
``stt.picovoice.speech``
==========================================
.. automodule:: platypush.backend.stt.picovoice.speech

@ -1,4 +1,4 @@
``platypush.backend.stt``
``stt``
=========================
.. automodule:: platypush.backend.stt

@ -1,4 +1,4 @@
``platypush.backend.tcp``
``tcp``
=========================
.. automodule:: platypush.backend.tcp

@ -1,4 +1,4 @@
``platypush.backend.todoist``
``todoist``
=============================
.. automodule:: platypush.backend.todoist

@ -1,4 +1,4 @@
``platypush.backend.travisci``
``travisci``
==============================
.. automodule:: platypush.backend.travisci

@ -1,4 +1,4 @@
``platypush.backend.trello``
``trello``
============================
.. automodule:: platypush.backend.trello

@ -1,4 +1,4 @@
``platypush.backend.weather.buienradar``
``weather.buienradar``
========================================
.. automodule:: platypush.backend.weather.buienradar

@ -1,4 +1,4 @@
``platypush.backend.weather.darksky``
``weather.darksky``
=====================================
.. automodule:: platypush.backend.weather.darksky

@ -1,4 +1,4 @@
``platypush.backend.weather.openweathermap``
``weather.openweathermap``
============================================
.. automodule:: platypush.backend.weather.openweathermap

@ -1,4 +1,4 @@
``platypush.backend.weather``
``weather``
=============================
.. automodule:: platypush.backend.weather

@ -1,4 +1,4 @@
``platypush.backend.websocket``
``websocket``
===============================
.. automodule:: platypush.backend.websocket

@ -1,4 +1,4 @@
``platypush.backend.wiimote``
``wiimote``
=============================
.. automodule:: platypush.backend.wiimote

@ -1,4 +1,4 @@
``platypush.backend.zigbee.mqtt``
``zigbee.mqtt``
=================================
.. automodule:: platypush.backend.zigbee.mqtt

@ -1,4 +1,4 @@
``platypush.backend.zwave.mqtt``
``zwave.mqtt``
================================
.. automodule:: platypush.backend.zwave.mqtt

@ -1,4 +1,4 @@
``platypush.backend.zwave``
``zwave``
===========================
.. automodule:: platypush.backend.zwave

@ -1,4 +1,4 @@
``platypush.message.event.adafruit``
``adafruit``
====================================
.. automodule:: platypush.message.event.adafruit

@ -1,4 +1,4 @@
``platypush.message.event.alarm``
``alarm``
=================================
.. automodule:: platypush.message.event.alarm

@ -1,4 +1,4 @@
``platypush.message.event.application``
``application``
=======================================
.. automodule:: platypush.message.event.application

@ -1,4 +1,4 @@
``platypush.message.event.assistant``
``assistant``
=====================================
.. automodule:: platypush.message.event.assistant

@ -1,4 +1,4 @@
``platypush.message.event.bluetooth``
``bluetooth``
=====================================
.. automodule:: platypush.message.event.bluetooth

@ -1,4 +1,4 @@
``platypush.message.event.button.flic``
``button.flic``
=======================================
.. automodule:: platypush.message.event.button.flic

@ -1,4 +1,4 @@
``platypush.message.event.camera``
``camera``
==================================
.. automodule:: platypush.message.event.camera

@ -1,4 +1,4 @@
``platypush.message.event.chat.telegram``
``chat.telegram``
=========================================
.. automodule:: platypush.message.event.chat.telegram

@ -1,4 +1,4 @@
``platypush.message.event.clipboard``
``clipboard``
=====================================
.. automodule:: platypush.message.event.clipboard

@ -1,4 +1,4 @@
``platypush.message.event.covid19``
``covid19``
===================================
.. automodule:: platypush.message.event.covid19

@ -1,4 +1,4 @@
``platypush.message.event.custom``
``custom``
==================================
.. automodule:: platypush.message.event.custom

@ -1,4 +1,4 @@
``platypush.message.event.distance``
``distance``
====================================
.. automodule:: platypush.message.event.distance

@ -1,4 +1,4 @@
``platypush.message.event.file``
``file``
================================
.. automodule:: platypush.message.event.file

@ -1,4 +1,4 @@
``platypush.message.event.foursquare``
``foursquare``
======================================
.. automodule:: platypush.message.event.foursquare

Some files were not shown because too many files have changed in this diff Show More

Loading…
Cancel
Save