From 8a867e20967f97e7e9cd1a0669422a16c2271e62 Mon Sep 17 00:00:00 2001 From: Teemu Rytilahti Date: Sun, 12 Jul 2020 23:09:57 +0200 Subject: [PATCH 1/3] add .readthedocs.yml required for poetry builds --- .readthedocs.yml | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 .readthedocs.yml diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 000000000..111706a8e --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,8 @@ +build: + image: latest + +python: + version: 3.6 + pip_install: true + extra_requirements: + - docs From e30597031cffda33ce653a0f8f7a3ac122369271 Mon Sep 17 00:00:00 2001 From: Teemu Rytilahti Date: Sun, 12 Jul 2020 23:12:39 +0200 Subject: [PATCH 2/3] require python 3.7 for builds --- .readthedocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index 111706a8e..0413384f0 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -2,7 +2,7 @@ build: image: latest python: - version: 3.6 + version: 3.7 pip_install: true extra_requirements: - docs From ab231deadd47e48bcbed8d1ee1e051d6d89ceb5a Mon Sep 17 00:00:00 2001 From: Teemu Rytilahti Date: Sun, 12 Jul 2020 23:20:36 +0200 Subject: [PATCH 3/3] Add documentation badge, fix the docs link --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d6891aaab..fb4b4b42f 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,7 @@ [![PyPI version](https://badge.fury.io/py/python-kasa.svg)](https://badge.fury.io/py/python-kasa) [![Build Status](https://dev.azure.com/python-kasa/python-kasa/_apis/build/status/python-kasa.python-kasa?branchName=master)](https://dev.azure.com/python-kasa/python-kasa/_build/latest?definitionId=2&branchName=master) [![Coverage Status](https://coveralls.io/repos/github/python-kasa/python-kasa/badge.svg?branch=master)](https://coveralls.io/github/python-kasa/python-kasa?branch=master) +[![Documentation Status](https://readthedocs.org/projects/python-kasa/badge/?version=latest)](https://python-kasa.readthedocs.io/en/latest/?badge=latest) python-kasa is a Python library to control TPLink smart home devices (plugs, wall switches, power strips, and bulbs) using asyncio. This project is a maintainer-made fork of [pyHS100](https://github.com/GadgetReactor/pyHS100) project. @@ -73,7 +74,7 @@ The commands are straightforward, so feel free to check `--help` for instruction # Library usage -You can find several code examples in [the API documentation](broken link). +You can find several code examples in [the API documentation](https://python-kasa.readthedocs.io). ## Contributing