Update documentation structure and start migrating to markdown (#934)

Starts structuring the documentation library usage into Tutorials, Guides, Explanations and Reference.
Continues migrating new docs from rst to markdown.
Extends the test framework discovery mocks to allow easy writing and testing of code examples.
This commit is contained in:
Steven B
2024-06-03 12:14:10 +03:00
committed by GitHub
parent 767156421b
commit 6616d68d42
31 changed files with 619 additions and 324 deletions

24
docs/source/deprecated.md Normal file
View File

@@ -0,0 +1,24 @@
# Deprecated API
```{currentmodule} kasa
```
The page contains the documentation for the deprecated library API that only works with the older kasa devices.
If you want to continue to use the old API for older devices,
you can use the classes in the `iot` module to avoid deprecation warnings.
```py
from kasa.iot import IotDevice, IotBulb, IotPlug, IotDimmer, IotStrip, IotLightStrip
```
```{toctree}
:maxdepth: 2
smartdevice
smartbulb
smartplug
smartdimmer
smartstrip
smartlightstrip
```