Improve rst documentation

albertogeniola · Dec 28, 2022 · 7530962 · 7530962
1 parent 5d0d4a6
commit 7530962
Show file tree

Hide file tree

Showing 9 changed files with 47 additions and 15 deletions.
diff --git a/...pi-reference/controller/mixins/garage.rst → ...api-reference/controller/mixins/cover.rst b/...pi-reference/controller/mixins/garage.rst → ...api-reference/controller/mixins/cover.rst
diff --git a/docs/api-reference/controller/mixins/diffuserlight.rst b/docs/api-reference/controller/mixins/diffuserlight.rst
@@ -0,0 +1,5 @@
+DiffuserLightMixin
+------------
+
+.. autoclass:: meross_iot.controller.mixins.diffuser_light.DiffuserLightMixin
+   :members:
diff --git a/docs/api-reference/controller/mixins/diffuserspray.rst b/docs/api-reference/controller/mixins/diffuserspray.rst
@@ -0,0 +1,5 @@
+DiffuserSprayMixin
+------------
+
+.. autoclass:: meross_iot.controller.mixins.diffuser_spray.DiffuserSprayMixin
+   :members:
diff --git a/docs/api-reference/controller/mixins/dnd.rst b/docs/api-reference/controller/mixins/dnd.rst
@@ -1,11 +1,5 @@
-ToggleXMixin
+DNDMixin
 ------------
 
-.. autoclass:: meross_iot.controller.mixins.toggle.ToggleXMixin
-   :members:
-
-ToggleMixin
-------------
-
-.. autoclass:: meross_iot.controller.mixins.toggle.ToggleMixin
+.. autoclass:: meross_iot.controller.mixins.dnd.SystemDndMixin
    :members:
diff --git a/docs/api-reference/controller/mixins/rollershutter.rst b/docs/api-reference/controller/mixins/rollershutter.rst
@@ -0,0 +1,5 @@
+RollerShutterMixin
+------------
+
+.. autoclass:: meross_iot.controller.mixins.roller_shutter.RollerShutterTimerMixin
+   :members:
diff --git a/docs/api-reference/controller/mixins/runtime.rst b/docs/api-reference/controller/mixins/runtime.rst
@@ -0,0 +1,5 @@
+System`RuntimeMixin
+------------
+
+.. autoclass:: meross_iot.controller.mixins.runtime.SystemRuntimeMixin
+   :members:
diff --git a/docs/api-reference/controller/mixins/thermostat.rst b/docs/api-reference/controller/mixins/thermostat.rst
@@ -0,0 +1,8 @@
+ThermostatMixin
+------------
+
+.. autoclass:: meross_iot.controller.mixins.thermostat.ThermostatModeMixin
+   :members:
+
+.. autoclass:: meross_iot.controller.mixins.thermostat.ThermostatState
+   :members:
diff --git a/docs/api-reference/controller/mixins/toggle.rst b/docs/api-reference/controller/mixins/toggle.rst
@@ -1,6 +1,11 @@
-DNDMixin
+ToggleXMixin
 ------------
 
-.. autoclass:: meross_iot.controller.mixins.dnd.SystemDndMixin
+.. autoclass:: meross_iot.controller.mixins.toggle.ToggleXMixin
    :members:
 
+ToggleMixin
+------------
+
+.. autoclass:: meross_iot.controller.mixins.toggle.ToggleMixin
+   :members:
diff --git a/docs/api-reference/index.rst b/docs/api-reference/index.rst
@@ -10,17 +10,22 @@ API Reference
    creds
    stats
    controller/device/base
-   controller/device/generic
-   controller/device/hub
-   controller/device/channel
    controller/device/channel
    controller/mixins/consumption
+   controller/mixins/diffuserlight
+   controller/mixins/diffuserspray
+   controller/mixins/dnd
    controller/mixins/electricity
-   controller/mixins/garage
+   controller/mixins/cover
+   controller/device/generic
    controller/mixins/hub
+   controller/device/hub
    controller/mixins/light
+   controller/mixins/rollershutter
+   controller/mixins/runtime
+   controller/subdevice/sensor
    controller/mixins/spray
    controller/mixins/system
+   controller/mixins/thermostat
    controller/mixins/toggle
-   controller/subdevice/sensor
    controller/subdevice/valve