Update docs with more howto examples (#968)

Co-authored-by: Teemu R. <tpr@iki.fi>
This commit is contained in:
Steven B
2024-06-19 09:53:40 +01:00
committed by GitHub
parent 6b46773609
commit 0d84d8785e
22 changed files with 646 additions and 86 deletions

View File

@@ -3,18 +3,16 @@
## Discover
```{module} kasa.discover
```{module} kasa
```
```{eval-rst}
.. autoclass:: kasa.Discover
.. autoclass:: Discover
:members:
```
## Device
```{module} kasa.device
```
```{eval-rst}
.. autoclass:: Device
@@ -25,17 +23,14 @@
## Device Config
```{module} kasa.credentials
```
```{eval-rst}
.. autoclass:: Credentials
:members:
:undoc-members:
:noindex:
```
```{module} kasa.deviceconfig
```
```{eval-rst}
.. autoclass:: DeviceConfig
@@ -45,19 +40,19 @@
```{eval-rst}
.. autoclass:: kasa.DeviceFamily
.. autoclass:: DeviceFamily
:members:
:undoc-members:
```
```{eval-rst}
.. autoclass:: kasa.DeviceConnection
.. autoclass:: DeviceConnectionParameters
:members:
:undoc-members:
```
```{eval-rst}
.. autoclass:: kasa.DeviceEncryption
.. autoclass:: DeviceEncryptionType
:members:
:undoc-members:
```
@@ -65,7 +60,15 @@
## Modules and Features
```{eval-rst}
.. autoclass:: kasa.Module
.. autoclass:: Module
:noindex:
:members:
:inherited-members:
:undoc-members:
```
```{eval-rst}
.. autoclass:: Feature
:noindex:
:members:
:inherited-members:
@@ -80,14 +83,6 @@
:undoc-members:
```
```{eval-rst}
.. autoclass:: kasa.Feature
:noindex:
:members:
:inherited-members:
:undoc-members:
```
## Protocols and transports
```{eval-rst}