grawlinson/smbmc
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

docs: add API reference

Browse source
This commit is contained in:
George Rawlinson 2020-11-20 07:52:35 +13:00
parent 186d9d761a
commit 7fbe059c0a
Signed by: grawlinson
GPG key ID: E0959FEA8B550539
1 changed files with 46 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

46
docs/api-reference.rst Normal file
View file

@ -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