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/tests/conftest.py

@@ -3,6 +3,7 @@ import glob
 import json
 import os
 from os.path import basename
+from pathlib import Path, PurePath
 from unittest.mock import MagicMock
 
 import pytest  # type: ignore # see https://github.com/pytest-dev/pytest/issues/3342
@@ -100,6 +101,38 @@ async def handle_turn_on(dev, turn_on):
 pytestmark = pytest.mark.asyncio
 
 
+def device_for_file(model):
+    for d in STRIPS:
+        if d in model:
+            return SmartStrip
+    for d in PLUGS:
+        if d in model:
+            return SmartPlug
+    for d in BULBS:
+        if d in model:
+            return SmartBulb
+    for d in DIMMERS:
+        if d in model:
+            return SmartDimmer
+
+    raise Exception("Unable to find type for %s", model)
+
+
+def get_device_for_file(file):
+    # if the wanted file is not an absolute path, prepend the fixtures directory
+    p = Path(file)
+    if not p.is_absolute():
+        p = Path(__file__).parent / "fixtures" / file
+
+    with open(p) as f:
+        sysinfo = json.load(f)
+        model = basename(file)
+        p = device_for_file(model)(host="123.123.123.123")
+        p.protocol = FakeTransportProtocol(sysinfo)
+        asyncio.run(p.update())
+        return p
+
+
 @pytest.fixture(params=SUPPORTED_DEVICES)
 def dev(request):
     """Device fixture.
@@ -117,29 +150,7 @@ def dev(request):
             return d
         raise Exception("Unable to find type for %s" % ip)
 
-    def device_for_file(model):
-        for d in STRIPS:
-            if d in model:
-                return SmartStrip
-        for d in PLUGS:
-            if d in model:
-                return SmartPlug
-        for d in BULBS:
-            if d in model:
-                return SmartBulb
-        for d in DIMMERS:
-            if d in model:
-                return SmartDimmer
-
-        raise Exception("Unable to find type for %s", model)
-
-    with open(file) as f:
-        sysinfo = json.load(f)
-        model = basename(file)
-        p = device_for_file(model)(host="123.123.123.123")
-        p.protocol = FakeTransportProtocol(sysinfo)
-        asyncio.run(p.update())
-        yield p
+    return get_device_for_file(file)
 
 
 def pytest_addoption(parser):