From 7fbe059c0ad9d69da6aec61aa3d0975850dcccde Mon Sep 17 00:00:00 2001 From: George Rawlinson Date: Fri, 20 Nov 2020 07:52:35 +1300 Subject: [PATCH] docs: add API reference --- docs/api-reference.rst | 46 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 docs/api-reference.rst diff --git a/docs/api-reference.rst b/docs/api-reference.rst new file mode 100644 index 0000000..6ba79b3 --- /dev/null +++ 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