From f9ce4b75e8b3908081adc3358cedeecc8fd04813 Mon Sep 17 00:00:00 2001 From: Fabio Manganiello Date: Mon, 3 Apr 2023 00:45:13 +0200 Subject: [PATCH] Updated docs --- docs/source/backends.rst | 11 ----------- .../platypush/backend/sensor.accelerometer.rst | 6 ------ .../platypush/backend/sensor.arduino.rst | 5 ----- .../source/platypush/backend/sensor.bme280.rst | 6 ------ docs/source/platypush/backend/sensor.dht.rst | 5 ----- .../platypush/backend/sensor.distance.rst | 5 ----- .../backend/sensor.distance.vl53l1x.rst | 6 ------ .../platypush/backend/sensor.envirophat.rst | 6 ------ .../source/platypush/backend/sensor.ltr559.rst | 6 ------ .../platypush/backend/sensor.mcp3008.rst | 8 -------- .../backend/sensor.motion.pmw3901.rst | 5 ----- .../source/platypush/backend/sensor.serial.rst | 6 ------ .../plugins/gpio.sensor.accelerometer.rst | 6 ------ .../platypush/plugins/gpio.sensor.bme280.rst | 6 ------ .../platypush/plugins/gpio.sensor.dht.rst | 5 ----- .../platypush/plugins/gpio.sensor.distance.rst | 6 ------ .../plugins/gpio.sensor.distance.vl53l1x.rst | 6 ------ .../plugins/gpio.sensor.envirophat.rst | 6 ------ .../platypush/plugins/gpio.sensor.ltr559.rst | 6 ------ .../platypush/plugins/gpio.sensor.mcp3008.rst | 7 ------- .../plugins/gpio.sensor.motion.pmw3901.rst | 5 ----- .../source/platypush/plugins/sensor.bme280.rst | 5 +++++ docs/source/platypush/plugins/sensor.dht.rst | 5 +++++ .../plugins/sensor.distance.vl53l1x.rst | 5 +++++ .../platypush/plugins/sensor.envirophat.rst | 5 +++++ .../source/platypush/plugins/sensor.hcsr04.rst | 5 +++++ .../source/platypush/plugins/sensor.lis3dh.rst | 5 +++++ .../source/platypush/plugins/sensor.ltr559.rst | 5 +++++ .../platypush/plugins/sensor.mcp3008.rst | 5 +++++ .../platypush/plugins/sensor.pmw3901.rst | 5 +++++ docs/source/plugins.rst | 18 +++++++++--------- 31 files changed, 54 insertions(+), 137 deletions(-) delete mode 100644 docs/source/platypush/backend/sensor.accelerometer.rst delete mode 100644 docs/source/platypush/backend/sensor.arduino.rst delete mode 100644 docs/source/platypush/backend/sensor.bme280.rst delete mode 100644 docs/source/platypush/backend/sensor.dht.rst delete mode 100644 docs/source/platypush/backend/sensor.distance.rst delete mode 100644 docs/source/platypush/backend/sensor.distance.vl53l1x.rst delete mode 100644 docs/source/platypush/backend/sensor.envirophat.rst delete mode 100644 docs/source/platypush/backend/sensor.ltr559.rst delete mode 100644 docs/source/platypush/backend/sensor.mcp3008.rst delete mode 100644 docs/source/platypush/backend/sensor.motion.pmw3901.rst delete mode 100644 docs/source/platypush/backend/sensor.serial.rst delete mode 100644 docs/source/platypush/plugins/gpio.sensor.accelerometer.rst delete mode 100644 docs/source/platypush/plugins/gpio.sensor.bme280.rst delete mode 100644 docs/source/platypush/plugins/gpio.sensor.dht.rst delete mode 100644 docs/source/platypush/plugins/gpio.sensor.distance.rst delete mode 100644 docs/source/platypush/plugins/gpio.sensor.distance.vl53l1x.rst delete mode 100644 docs/source/platypush/plugins/gpio.sensor.envirophat.rst delete mode 100644 docs/source/platypush/plugins/gpio.sensor.ltr559.rst delete mode 100644 docs/source/platypush/plugins/gpio.sensor.mcp3008.rst delete mode 100644 docs/source/platypush/plugins/gpio.sensor.motion.pmw3901.rst create mode 100644 docs/source/platypush/plugins/sensor.bme280.rst create mode 100644 docs/source/platypush/plugins/sensor.dht.rst create mode 100644 docs/source/platypush/plugins/sensor.distance.vl53l1x.rst create mode 100644 docs/source/platypush/plugins/sensor.envirophat.rst create mode 100644 docs/source/platypush/plugins/sensor.hcsr04.rst create mode 100644 docs/source/platypush/plugins/sensor.lis3dh.rst create mode 100644 docs/source/platypush/plugins/sensor.ltr559.rst create mode 100644 docs/source/platypush/plugins/sensor.mcp3008.rst create mode 100644 docs/source/platypush/plugins/sensor.pmw3901.rst diff --git a/docs/source/backends.rst b/docs/source/backends.rst index 8ed332869..685f92e12 100644 --- a/docs/source/backends.rst +++ b/docs/source/backends.rst @@ -43,20 +43,9 @@ Backends platypush/backend/pushbullet.rst platypush/backend/redis.rst platypush/backend/scard.rst - platypush/backend/sensor.accelerometer.rst - platypush/backend/sensor.arduino.rst platypush/backend/sensor.battery.rst - platypush/backend/sensor.bme280.rst - platypush/backend/sensor.dht.rst - platypush/backend/sensor.distance.rst - platypush/backend/sensor.distance.vl53l1x.rst - platypush/backend/sensor.envirophat.rst platypush/backend/sensor.ir.zeroborg.rst platypush/backend/sensor.leap.rst - platypush/backend/sensor.ltr559.rst - platypush/backend/sensor.mcp3008.rst - platypush/backend/sensor.motion.pmw3901.rst - platypush/backend/sensor.serial.rst platypush/backend/stt.deepspeech.rst platypush/backend/stt.picovoice.hotword.rst platypush/backend/stt.picovoice.speech.rst diff --git a/docs/source/platypush/backend/sensor.accelerometer.rst b/docs/source/platypush/backend/sensor.accelerometer.rst deleted file mode 100644 index 80692bc64..000000000 --- a/docs/source/platypush/backend/sensor.accelerometer.rst +++ /dev/null @@ -1,6 +0,0 @@ -``sensor.accelerometer`` -========================================== - -.. automodule:: platypush.backend.sensor.accelerometer - :members: - diff --git a/docs/source/platypush/backend/sensor.arduino.rst b/docs/source/platypush/backend/sensor.arduino.rst deleted file mode 100644 index 48f65bfa3..000000000 --- a/docs/source/platypush/backend/sensor.arduino.rst +++ /dev/null @@ -1,5 +0,0 @@ -``sensor.arduino`` -==================================== - -.. automodule:: platypush.backend.sensor.arduino - :members: diff --git a/docs/source/platypush/backend/sensor.bme280.rst b/docs/source/platypush/backend/sensor.bme280.rst deleted file mode 100644 index 786cb46a6..000000000 --- a/docs/source/platypush/backend/sensor.bme280.rst +++ /dev/null @@ -1,6 +0,0 @@ -``sensor.bme280`` -=================================== - -.. automodule:: platypush.backend.sensor.bme280 - :members: - diff --git a/docs/source/platypush/backend/sensor.dht.rst b/docs/source/platypush/backend/sensor.dht.rst deleted file mode 100644 index 3f7e585b8..000000000 --- a/docs/source/platypush/backend/sensor.dht.rst +++ /dev/null @@ -1,5 +0,0 @@ -``sensor.dht`` -================================ - -.. automodule:: platypush.backend.sensor.dht - :members: diff --git a/docs/source/platypush/backend/sensor.distance.rst b/docs/source/platypush/backend/sensor.distance.rst deleted file mode 100644 index a1bc34a98..000000000 --- a/docs/source/platypush/backend/sensor.distance.rst +++ /dev/null @@ -1,5 +0,0 @@ -``sensor.distance`` -===================================== - -.. automodule:: platypush.backend.sensor.distance - :members: diff --git a/docs/source/platypush/backend/sensor.distance.vl53l1x.rst b/docs/source/platypush/backend/sensor.distance.vl53l1x.rst deleted file mode 100644 index 2023c6485..000000000 --- a/docs/source/platypush/backend/sensor.distance.vl53l1x.rst +++ /dev/null @@ -1,6 +0,0 @@ -``sensor.distance.vl53l1x`` -============================================= - -.. automodule:: platypush.backend.sensor.distance.vl53l1x - :members: - diff --git a/docs/source/platypush/backend/sensor.envirophat.rst b/docs/source/platypush/backend/sensor.envirophat.rst deleted file mode 100644 index 539de9bc3..000000000 --- a/docs/source/platypush/backend/sensor.envirophat.rst +++ /dev/null @@ -1,6 +0,0 @@ -``sensor.envirophat`` -======================================= - -.. automodule:: platypush.backend.sensor.envirophat - :members: - diff --git a/docs/source/platypush/backend/sensor.ltr559.rst b/docs/source/platypush/backend/sensor.ltr559.rst deleted file mode 100644 index a8ab4aeed..000000000 --- a/docs/source/platypush/backend/sensor.ltr559.rst +++ /dev/null @@ -1,6 +0,0 @@ -``sensor.ltr559`` -=================================== - -.. automodule:: platypush.backend.sensor.ltr559 - :members: - diff --git a/docs/source/platypush/backend/sensor.mcp3008.rst b/docs/source/platypush/backend/sensor.mcp3008.rst deleted file mode 100644 index 77b1273df..000000000 --- a/docs/source/platypush/backend/sensor.mcp3008.rst +++ /dev/null @@ -1,8 +0,0 @@ -``sensor.mcp3008`` -==================================== - -.. automodule:: platypush.backend.sensor.mcp3008 - :members: - - - diff --git a/docs/source/platypush/backend/sensor.motion.pmw3901.rst b/docs/source/platypush/backend/sensor.motion.pmw3901.rst deleted file mode 100644 index 350385b92..000000000 --- a/docs/source/platypush/backend/sensor.motion.pmw3901.rst +++ /dev/null @@ -1,5 +0,0 @@ -``sensor.motion.pmw3901`` -========================= - -.. automodule:: platypush.backend.sensor.motion.pmw3901 - :members: diff --git a/docs/source/platypush/backend/sensor.serial.rst b/docs/source/platypush/backend/sensor.serial.rst deleted file mode 100644 index 769e309a7..000000000 --- a/docs/source/platypush/backend/sensor.serial.rst +++ /dev/null @@ -1,6 +0,0 @@ -``sensor.serial`` -=================================== - -.. automodule:: platypush.backend.sensor.serial - :members: - diff --git a/docs/source/platypush/plugins/gpio.sensor.accelerometer.rst b/docs/source/platypush/plugins/gpio.sensor.accelerometer.rst deleted file mode 100644 index fa0944a03..000000000 --- a/docs/source/platypush/plugins/gpio.sensor.accelerometer.rst +++ /dev/null @@ -1,6 +0,0 @@ -``gpio.sensor.accelerometer`` -=============================================== - -.. automodule:: platypush.plugins.gpio.sensor.accelerometer - :members: - diff --git a/docs/source/platypush/plugins/gpio.sensor.bme280.rst b/docs/source/platypush/plugins/gpio.sensor.bme280.rst deleted file mode 100644 index fcfac1652..000000000 --- a/docs/source/platypush/plugins/gpio.sensor.bme280.rst +++ /dev/null @@ -1,6 +0,0 @@ -``gpio.sensor.bme280`` -======================================== - -.. automodule:: platypush.plugins.gpio.sensor.bme280 - :members: - diff --git a/docs/source/platypush/plugins/gpio.sensor.dht.rst b/docs/source/platypush/plugins/gpio.sensor.dht.rst deleted file mode 100644 index a112712af..000000000 --- a/docs/source/platypush/plugins/gpio.sensor.dht.rst +++ /dev/null @@ -1,5 +0,0 @@ -``gpio.sensor.dht`` -===================================== - -.. automodule:: platypush.plugins.gpio.sensor.dht - :members: diff --git a/docs/source/platypush/plugins/gpio.sensor.distance.rst b/docs/source/platypush/plugins/gpio.sensor.distance.rst deleted file mode 100644 index 83c8a6782..000000000 --- a/docs/source/platypush/plugins/gpio.sensor.distance.rst +++ /dev/null @@ -1,6 +0,0 @@ -``gpio.sensor.distance`` -========================================== - -.. automodule:: platypush.plugins.gpio.sensor.distance - :members: - diff --git a/docs/source/platypush/plugins/gpio.sensor.distance.vl53l1x.rst b/docs/source/platypush/plugins/gpio.sensor.distance.vl53l1x.rst deleted file mode 100644 index 14fc4f47c..000000000 --- a/docs/source/platypush/plugins/gpio.sensor.distance.vl53l1x.rst +++ /dev/null @@ -1,6 +0,0 @@ -``gpio.sensor.distance.vl53l1x`` -================================================== - -.. automodule:: platypush.plugins.gpio.sensor.distance.vl53l1x - :members: - diff --git a/docs/source/platypush/plugins/gpio.sensor.envirophat.rst b/docs/source/platypush/plugins/gpio.sensor.envirophat.rst deleted file mode 100644 index 7ca339372..000000000 --- a/docs/source/platypush/plugins/gpio.sensor.envirophat.rst +++ /dev/null @@ -1,6 +0,0 @@ -``gpio.sensor.envirophat`` -============================================ - -.. automodule:: platypush.plugins.gpio.sensor.envirophat - :members: - diff --git a/docs/source/platypush/plugins/gpio.sensor.ltr559.rst b/docs/source/platypush/plugins/gpio.sensor.ltr559.rst deleted file mode 100644 index 10869c4b7..000000000 --- a/docs/source/platypush/plugins/gpio.sensor.ltr559.rst +++ /dev/null @@ -1,6 +0,0 @@ -``gpio.sensor.ltr559`` -======================================== - -.. automodule:: platypush.plugins.gpio.sensor.ltr559 - :members: - diff --git a/docs/source/platypush/plugins/gpio.sensor.mcp3008.rst b/docs/source/platypush/plugins/gpio.sensor.mcp3008.rst deleted file mode 100644 index 9a5ce35eb..000000000 --- a/docs/source/platypush/plugins/gpio.sensor.mcp3008.rst +++ /dev/null @@ -1,7 +0,0 @@ -``gpio.sensor.mcp3008`` -========================================= - -.. automodule:: platypush.plugins.gpio.sensor.mcp3008 - :members: - - diff --git a/docs/source/platypush/plugins/gpio.sensor.motion.pmw3901.rst b/docs/source/platypush/plugins/gpio.sensor.motion.pmw3901.rst deleted file mode 100644 index d199d29e0..000000000 --- a/docs/source/platypush/plugins/gpio.sensor.motion.pmw3901.rst +++ /dev/null @@ -1,5 +0,0 @@ -``gpio.sensor.motion.pmw3901`` -============================== - -.. automodule:: platypush.plugins.gpio.sensor.motion.pmw3901 - :members: diff --git a/docs/source/platypush/plugins/sensor.bme280.rst b/docs/source/platypush/plugins/sensor.bme280.rst new file mode 100644 index 000000000..cee968e5e --- /dev/null +++ b/docs/source/platypush/plugins/sensor.bme280.rst @@ -0,0 +1,5 @@ +``sensor.bme280`` +================= + +.. automodule:: platypush.plugins.sensor.bme280 + :members: diff --git a/docs/source/platypush/plugins/sensor.dht.rst b/docs/source/platypush/plugins/sensor.dht.rst new file mode 100644 index 000000000..4805e2248 --- /dev/null +++ b/docs/source/platypush/plugins/sensor.dht.rst @@ -0,0 +1,5 @@ +``sensor.dht`` +============== + +.. automodule:: platypush.plugins.sensor.dht + :members: diff --git a/docs/source/platypush/plugins/sensor.distance.vl53l1x.rst b/docs/source/platypush/plugins/sensor.distance.vl53l1x.rst new file mode 100644 index 000000000..654a555c3 --- /dev/null +++ b/docs/source/platypush/plugins/sensor.distance.vl53l1x.rst @@ -0,0 +1,5 @@ +``sensor.distance.vl53l1x`` +=========================== + +.. automodule:: platypush.plugins.sensor.distance.vl53l1x + :members: diff --git a/docs/source/platypush/plugins/sensor.envirophat.rst b/docs/source/platypush/plugins/sensor.envirophat.rst new file mode 100644 index 000000000..b77105923 --- /dev/null +++ b/docs/source/platypush/plugins/sensor.envirophat.rst @@ -0,0 +1,5 @@ +``sensor.envirophat`` +===================== + +.. automodule:: platypush.plugins.sensor.envirophat + :members: diff --git a/docs/source/platypush/plugins/sensor.hcsr04.rst b/docs/source/platypush/plugins/sensor.hcsr04.rst new file mode 100644 index 000000000..77671547b --- /dev/null +++ b/docs/source/platypush/plugins/sensor.hcsr04.rst @@ -0,0 +1,5 @@ +``sensor.hcsr04`` +================= + +.. automodule:: platypush.plugins.sensor.hcsr04 + :members: diff --git a/docs/source/platypush/plugins/sensor.lis3dh.rst b/docs/source/platypush/plugins/sensor.lis3dh.rst new file mode 100644 index 000000000..ccb7d8499 --- /dev/null +++ b/docs/source/platypush/plugins/sensor.lis3dh.rst @@ -0,0 +1,5 @@ +``sensor.lis3dh`` +================= + +.. automodule:: platypush.plugins.sensor.lis3dh + :members: diff --git a/docs/source/platypush/plugins/sensor.ltr559.rst b/docs/source/platypush/plugins/sensor.ltr559.rst new file mode 100644 index 000000000..a12e11caa --- /dev/null +++ b/docs/source/platypush/plugins/sensor.ltr559.rst @@ -0,0 +1,5 @@ +``sensor.ltr559`` +================= + +.. automodule:: platypush.plugins.sensor.ltr559 + :members: diff --git a/docs/source/platypush/plugins/sensor.mcp3008.rst b/docs/source/platypush/plugins/sensor.mcp3008.rst new file mode 100644 index 000000000..157ba548b --- /dev/null +++ b/docs/source/platypush/plugins/sensor.mcp3008.rst @@ -0,0 +1,5 @@ +``sensor.mcp3008`` +================== + +.. automodule:: platypush.plugins.sensor.mcp3008 + :members: diff --git a/docs/source/platypush/plugins/sensor.pmw3901.rst b/docs/source/platypush/plugins/sensor.pmw3901.rst new file mode 100644 index 000000000..891a7d156 --- /dev/null +++ b/docs/source/platypush/plugins/sensor.pmw3901.rst @@ -0,0 +1,5 @@ +``sensor.pmw3901`` +================== + +.. automodule:: platypush.plugins.sensor.pmw3901 + :members: diff --git a/docs/source/plugins.rst b/docs/source/plugins.rst index 4ab09fc7f..d17134263 100644 --- a/docs/source/plugins.rst +++ b/docs/source/plugins.rst @@ -46,15 +46,6 @@ Plugins platypush/plugins/google.youtube.rst platypush/plugins/gotify.rst platypush/plugins/gpio.rst - platypush/plugins/gpio.sensor.accelerometer.rst - platypush/plugins/gpio.sensor.bme280.rst - platypush/plugins/gpio.sensor.dht.rst - platypush/plugins/gpio.sensor.distance.rst - platypush/plugins/gpio.sensor.distance.vl53l1x.rst - platypush/plugins/gpio.sensor.envirophat.rst - platypush/plugins/gpio.sensor.ltr559.rst - platypush/plugins/gpio.sensor.mcp3008.rst - platypush/plugins/gpio.sensor.motion.pmw3901.rst platypush/plugins/gpio.zeroborg.rst platypush/plugins/graphite.rst platypush/plugins/hid.rst @@ -110,6 +101,15 @@ Plugins platypush/plugins/redis.rst platypush/plugins/rss.rst platypush/plugins/rtorrent.rst + platypush/plugins/sensor.bme280.rst + platypush/plugins/sensor.dht.rst + platypush/plugins/sensor.distance.vl53l1x.rst + platypush/plugins/sensor.envirophat.rst + platypush/plugins/sensor.hcsr04.rst + platypush/plugins/sensor.lis3dh.rst + platypush/plugins/sensor.ltr559.rst + platypush/plugins/sensor.mcp3008.rst + platypush/plugins/sensor.pmw3901.rst platypush/plugins/serial.rst platypush/plugins/shell.rst platypush/plugins/slack.rst