From 1eaae37c5548e3074edd231ce4d49985399f784d Mon Sep 17 00:00:00 2001 From: "Teemu R." Date: Wed, 13 Nov 2024 18:42:45 +0100 Subject: [PATCH] Add linkcheck to readthedocs CI (#1253) --- .readthedocs.yml | 3 +++ README.md | 2 +- docs/source/contribute.md | 2 +- 3 files changed, 5 insertions(+), 2 deletions(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index e79a0598..1d01cf18 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -6,6 +6,9 @@ build: os: ubuntu-22.04 tools: python: "3" + jobs: + pre_build: + - python -m sphinx -b linkcheck docs/source/ $READTHEDOCS_OUTPUT/linkcheck python: install: diff --git a/README.md b/README.md index 0da595a8..60ff35a2 100644 --- a/README.md +++ b/README.md @@ -211,7 +211,7 @@ See [supported devices in our documentation](SUPPORTED.md) for more detailed inf ### Developer Resources -* [softScheck's github contains lot of information and wireshark dissector](https://github.com/softScheck/tplink-smartplug#wireshark-dissector) +* [softScheck's github contains lot of information and wireshark dissector](https://github.com/softScheck/tplink-smartplug) * [TP-Link Smart Home Device Simulator](https://github.com/plasticrake/tplink-smarthome-simulator) * [Unofficial API documentation](https://github.com/plasticrake/tplink-smarthome-api) * [Another unofficial API documentation](https://github.com/whitslack/kasa) diff --git a/docs/source/contribute.md b/docs/source/contribute.md index 2f735ce1..8a060383 100644 --- a/docs/source/contribute.md +++ b/docs/source/contribute.md @@ -49,7 +49,7 @@ Note that this will perform state changes on the device. ## Analyzing network captures The simplest way to add support for a new device or to improve existing ones is to capture traffic between the mobile app and the device. -After capturing the traffic, you can either use the [softScheck's wireshark dissector](https://github.com/softScheck/tplink-smartplug#wireshark-dissector) +After capturing the traffic, you can either use the [softScheck's wireshark dissector](https://github.com/softScheck/tplink-smartplug) or the `parse_pcap.py` script contained inside the `devtools` directory. Note, that this works currently only on kasa-branded devices which use port 9999 for communications.