diff --git a/docs/source/cli.rst b/docs/source/cli.rst index 340a64e6..b09ae11d 100644 --- a/docs/source/cli.rst +++ b/docs/source/cli.rst @@ -1,7 +1,7 @@ Command-line usage ================== -The package is shipped with a console tool named kasa, please refer to ``kasa --help`` for detailed usage. +The package is shipped with a console tool named ``kasa``, refer to ``kasa --help`` for detailed usage. The device to which the commands are sent is chosen by ``KASA_HOST`` environment variable or passing ``--host
`` as an option. To see what is being sent to and received from the device, specify option ``--debug``. diff --git a/docs/source/design.rst b/docs/source/design.rst index 140c83d8..8acbfea6 100644 --- a/docs/source/design.rst +++ b/docs/source/design.rst @@ -9,6 +9,9 @@ This page aims to provide some details on the design and internals of this libra You might be interested in this if you want to improve this library, or if you are just looking to access some information that is not currently exposed. +.. contents:: Contents + :local: + .. _update_cycle: Update Cycle diff --git a/docs/source/discover.rst b/docs/source/discover.rst index f47f50d7..87b14ee7 100644 --- a/docs/source/discover.rst +++ b/docs/source/discover.rst @@ -1,16 +1,11 @@ Discovering devices =================== -.. code-block:: - - import asyncio - from kasa import Discover - - devices = asyncio.run(Discover.discover()) - for addr, dev in devices.items(): - asyncio.run(dev.update()) - print(f"{addr} >> {dev}") +.. contents:: Contents + :local: +API documentation +***************** .. autoclass:: kasa.Discover :members: diff --git a/docs/source/smartbulb.rst b/docs/source/smartbulb.rst index 3f2baa40..6261cb7b 100644 --- a/docs/source/smartbulb.rst +++ b/docs/source/smartbulb.rst @@ -1,6 +1,9 @@ Bulbs =========== +.. contents:: Contents + :local: + Supported features ****************** diff --git a/docs/source/smartdevice.rst b/docs/source/smartdevice.rst index 42b83856..d8ef58b2 100644 --- a/docs/source/smartdevice.rst +++ b/docs/source/smartdevice.rst @@ -3,6 +3,12 @@ Common API ========== +.. contents:: Contents + :local: + +SmartDevice class +***************** + The basic functionalities of all supported devices are accessible using the common :class:`SmartDevice` base class. The property accesses use the data obtained before by awaiting :func:`SmartDevice.update()`. diff --git a/docs/source/smartdimmer.rst b/docs/source/smartdimmer.rst index b44d8e0c..62d70142 100644 --- a/docs/source/smartdimmer.rst +++ b/docs/source/smartdimmer.rst @@ -1,6 +1,10 @@ Dimmers ======= +.. contents:: Contents + :local: + + .. note:: Feel free to open a pull request to improve the documentation! diff --git a/docs/source/smartlightstrip.rst b/docs/source/smartlightstrip.rst index b961be5b..d0d99ce4 100644 --- a/docs/source/smartlightstrip.rst +++ b/docs/source/smartlightstrip.rst @@ -1,6 +1,9 @@ Light strips ============ +.. contents:: Contents + :local: + .. note:: Feel free to open a pull request to improve the documentation! diff --git a/docs/source/smartplug.rst b/docs/source/smartplug.rst index 94305ca8..ff562c93 100644 --- a/docs/source/smartplug.rst +++ b/docs/source/smartplug.rst @@ -1,6 +1,9 @@ Plugs ===== +.. contents:: Contents + :local: + .. note:: Feel free to open a pull request to improve the documentation! diff --git a/docs/source/smartstrip.rst b/docs/source/smartstrip.rst index 66d78f9c..411ccde1 100644 --- a/docs/source/smartstrip.rst +++ b/docs/source/smartstrip.rst @@ -1,6 +1,9 @@ Smart strips ============ +.. contents:: Contents + :local: + .. note:: Feel free to open a pull request to improve the documentation!