7 Commits

Author	SHA1	Message	Date
Steven B	8c39e81a40	Rename and deprecate exception classes (#739) ... # Public # SmartDeviceException -> KasaException UnsupportedDeviceException(SmartDeviceException) -> UnsupportedDeviceError(KasaException) TimeoutException(SmartDeviceException, asyncio.TimeoutError) -> TimeoutError(KasaException, asyncio.TimeoutError) Add new exception for error codes -> DeviceError(KasaException) AuthenticationException(SmartDeviceException) -> AuthenticationError(DeviceError) # Internal # RetryableException(SmartDeviceException) -> _RetryableError(DeviceError) ConnectionException(SmartDeviceException) -> _ConnectionError(KasaException)	2024-02-21 16:52:55 +01:00
Steven B	3e0cd07b7c	Update docs for newer devices and DeviceConfig (#614) ... * Update docs for newer devices and DeviceConfig * Tweak docs post review * Move sentence to newline * Update post review * Update following review	2024-01-10 20:13:14 +01:00
Teemu R	2eecf39bae	Add ToCs for doc pages (#380)	2022-10-18 19:08:10 +02:00
Teemu R	d848117384	Various documentation updates (#333) ... * Add a note about socket sharing * Show inherited members for apidocs * Remove outdated note of emeters not being supported on smartstrips * Describe emeter and usage modules, add note about NTP for time sync * Describe lib design and modules * Bump sphinx version, ignore d001 (line-length) for doc8 * demote energy & usage to 3rd level, promote api for 2nd	2022-04-06 01:13:27 +02:00
Teemu R	98b40b5072	Improve cli documentation for bulbs and power strips (#123)	2020-12-09 11:13:14 +02:00
Teemu R	6844166c0d	add a small example script to show library usage (#90) ... * add a small example script to show library usage * asyncio.run++	2020-07-20 16:42:37 +02:00
Teemu R	f9a987ca18	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..	2020-06-30 02:29:52 +02:00