Simplify API documentation by using doctests (#73)

* Add doctests to SmartBulb

* Add SmartDevice doctests, cleanup README.md

* add doctests for smartplug and smartstrip

* add discover doctests

* Fix bulb mock

* add smartdimmer doctests

* add sphinx-generated docs, cleanup readme a bit

* remove sphinx-click as it does not work with asyncclick

* in preparation for rtd hooking, move doc deps to be separate from dev deps

* pytestmark needs to be applied separately for each and every file, this fixes the tests

* use pathlib for resolving relative paths

* Skip discovery doctest on python3.7

The code is just fine, but some reason the mocking behaves differently between 3.7 and 3.8.
The latter seems to accept a discrete object for asyncio.run where the former expects a coroutine..

kasa/smartstrip.py

@@ -18,28 +18,52 @@ _LOGGER = logging.getLogger(__name__)
 class SmartStrip(SmartDevice):
     """Representation of a TP-Link Smart Power Strip.
 
-    Usage example when used as library:
-    ```python
-    p = SmartStrip("192.168.1.105")
+    A strip consists of the parent device and its children.
+    All methods of the parent act on all children, while the child devices
+    share the common API with the :class:`SmartPlug` class.
 
-    # query the state of the strip
-    await p.update()
-    print(p.is_on)
+    To initialize, you have to await :func:`update()` at least once.
+    This will allow accessing the properties using the exposed properties.
 
-    # change state of all outlets
-    await p.turn_on()
-    await p.turn_off()
+    All changes to the device are done using awaitable methods,
+    which will not change the cached values, but you must await :func:`update()` separately.
 
-    # individual outlets are accessible through plugs variable
-    for plug in p.plugs:
-        print(f"{p}: {p.is_on}")
-
-    # change state of a single outlet
-    await p.plugs[0].turn_on()
-    ```
-
-    Errors reported by the device are raised as SmartDeviceExceptions,
+    Errors reported by the device are raised as :class:`SmartDeviceException`s,
     and should be handled by the user of the library.
+
+    Examples:
+        >>> import asyncio
+        >>> strip = SmartStrip("127.0.0.1")
+        >>> asyncio.run(strip.update())
+        >>> strip.alias
+        TP-LINK_Power Strip_CF69
+
+        All methods act on the whole strip:
+
+        >>> for plug in strip.children:
+        >>>    print(f"{plug.alias}: {plug.is_on}")
+        Plug 1: True
+        Plug 2: False
+        Plug 3: False
+        >>> strip.is_on
+        True
+        >>> asyncio.run(strip.turn_off())
+
+        Accessing individual plugs can be done using the `children` property:
+
+        >>> len(strip.children)
+        3
+        >>> for plug in strip.children:
+        >>>    print(f"{plug.alias}: {plug.is_on}")
+        Plug 1: False
+        Plug 2: False
+        Plug 3: False
+        >>> asyncio.run(strip.children[1].turn_on())
+        >>> asyncio.run(strip.update())
+        >>> strip.is_on
+        True
+
+    For more examples, see the :class:`SmartDevice` class.
     """
 
     def __init__(self, host: str) -> None:
@@ -212,7 +236,7 @@ class SmartStripPlug(SmartPlug):
     def is_on(self) -> bool:
         """Return whether device is on."""
         info = self._get_child_info()
-        return info["state"]
+        return bool(info["state"])
 
     @property  # type: ignore
     @requires_update