docs: add API reference

2020-11-20 07:52:35 +13:00 · 2020-11-20 07:52:35 +13:00 · 7fbe059c0a
parent 186d9d761a
commit 7fbe059c0a
1 changed files with 46 additions and 0 deletions
--- a/docs/api-reference.rst
+++ b/docs/api-reference.rst
@ -0,0 +1,46 @@
+===============
+API Reference
+===============
+
+Classes
+=======
+
+Client
+------
+
+.. autoclass:: smbmc.Client
+   :members:
+   :inherited-members:
+
+Sensor
+------
+
+.. autoclass:: smbmc.models.Sensor
+
+Power Supply
+------------
+
+.. autoclass:: smbmc.models.PowerSupply
+
+Enums & Flags
+=============
+
+SensorStateEnum
+---------------
+
+.. autoclass:: smbmc.models.SensorStateEnum
+
+SensorUnitEnum
+--------------
+
+.. autoclass:: smbmc.models.SensorUnitEnum
+
+SensorTypeEnum
+--------------
+
+.. autoclass:: smbmc.models.SensorTypeEnum
+
+PowerSupplyFlag
+---------------
+
+.. autoclass:: smbmc.models.PowerSupplyFlag