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

View File

@@ -105,7 +105,7 @@ class IotDevice(Device):
All devices provide several informational properties:
>>> dev.alias
Kitchen
Bedroom Lamp Plug
>>> dev.model
HS110(EU)
>>> dev.rssi

View File

@@ -23,7 +23,7 @@ class IotLightStrip(IotBulb):
>>> strip = IotLightStrip("127.0.0.1")
>>> asyncio.run(strip.update())
>>> print(strip.alias)
KL430 pantry lightstrip
Bedroom Lightstrip
Getting the length of the strip:

View File

@@ -32,7 +32,7 @@ class IotPlug(IotDevice):
>>> plug = IotPlug("127.0.0.1")
>>> asyncio.run(plug.update())
>>> plug.alias
Kitchen
Bedroom Lamp Plug
Setting the LED state:

View File

@@ -55,7 +55,7 @@ class IotStrip(IotDevice):
>>> strip = IotStrip("127.0.0.1")
>>> asyncio.run(strip.update())
>>> strip.alias
TP-LINK_Power Strip_CF69
Bedroom Power Strip
All methods act on the whole strip: