From 97f9f8aa49be155c8dcf8c94817bfde53e4e8ee2 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Mon, 9 Nov 2015 13:12:18 +0100 Subject: [PATCH] Update link to docs (Jekyll 3 update) --- homeassistant/components/__init__.py | 2 - .../components/alarm_control_panel/manual.py | 2 +- .../components/alarm_control_panel/mqtt.py | 2 +- .../alarm_control_panel/verisure.py | 3 ++ homeassistant/components/api.py | 2 +- homeassistant/components/arduino.py | 2 +- .../components/automation/__init__.py | 4 +- homeassistant/components/automation/event.py | 2 +- homeassistant/components/automation/mqtt.py | 2 +- .../components/automation/numeric_state.py | 4 +- homeassistant/components/automation/state.py | 2 +- homeassistant/components/automation/sun.py | 2 +- homeassistant/components/automation/time.py | 2 +- homeassistant/components/automation/zone.py | 2 +- homeassistant/components/browser.py | 4 +- homeassistant/components/camera/__init__.py | 20 +------- homeassistant/components/camera/foscam.py | 2 +- homeassistant/components/camera/generic.py | 2 +- homeassistant/components/camera/mjpeg.py | 6 +-- homeassistant/components/conversation.py | 2 +- .../components/device_sun_light_trigger.py | 6 ++- .../components/device_tracker/__init__.py | 19 +------ .../components/device_tracker/actiontec.py | 2 +- .../components/device_tracker/aruba.py | 2 +- .../components/device_tracker/asuswrt.py | 28 +---------- .../components/device_tracker/ddwrt.py | 2 +- .../components/device_tracker/demo.py | 1 - .../components/device_tracker/geofancy.py | 3 +- .../components/device_tracker/luci.py | 2 +- .../components/device_tracker/mqtt.py | 2 +- .../components/device_tracker/netgear.py | 2 +- .../components/device_tracker/nmap_tracker.py | 2 +- .../components/device_tracker/owntracks.py | 2 +- .../components/device_tracker/snmp.py | 2 +- .../components/device_tracker/thomson.py | 2 +- .../components/device_tracker/tomato.py | 2 +- .../components/device_tracker/tplink.py | 2 +- .../components/device_tracker/ubus.py | 2 +- homeassistant/components/discovery.py | 1 - homeassistant/components/downloader.py | 2 +- homeassistant/components/group.py | 2 +- homeassistant/components/history.py | 2 +- homeassistant/components/http.py | 2 +- homeassistant/components/ifttt.py | 2 +- homeassistant/components/introduction.py | 2 +- homeassistant/components/isy994.py | 2 +- homeassistant/components/keyboard.py | 2 +- homeassistant/components/light/__init__.py | 49 +------------------ .../components/light/blinksticklight.py | 2 +- homeassistant/components/light/demo.py | 1 - homeassistant/components/light/hue.py | 3 +- homeassistant/components/light/hyperion.py | 3 +- homeassistant/components/light/isy994.py | 3 ++ .../components/light/limitlessled.py | 14 ++---- homeassistant/components/light/rfxtrx.py | 2 +- homeassistant/components/light/tellstick.py | 2 +- homeassistant/components/light/vera.py | 2 +- homeassistant/components/light/wink.py | 2 +- homeassistant/components/logbook.py | 2 +- homeassistant/components/logger.py | 2 +- .../components/media_player/__init__.py | 4 +- homeassistant/components/media_player/cast.py | 2 +- .../components/media_player/denon.py | 2 +- .../components/media_player/firetv.py | 2 +- .../components/media_player/itunes.py | 2 +- homeassistant/components/media_player/kodi.py | 2 +- homeassistant/components/media_player/mpd.py | 2 +- homeassistant/components/media_player/plex.py | 2 +- .../components/media_player/sonos.py | 2 +- .../components/media_player/squeezebox.py | 2 +- homeassistant/components/modbus.py | 2 +- homeassistant/components/mqtt/__init__.py | 2 +- homeassistant/components/recorder.py | 2 +- homeassistant/components/rfxtrx.py | 2 +- homeassistant/components/scene.py | 2 +- homeassistant/components/script.py | 2 +- homeassistant/components/sensor/__init__.py | 3 ++ homeassistant/components/sensor/arduino.py | 2 +- homeassistant/components/sensor/arest.py | 2 +- homeassistant/components/sensor/bitcoin.py | 2 +- .../components/sensor/command_sensor.py | 2 +- homeassistant/components/sensor/cpuspeed.py | 2 +- homeassistant/components/sensor/dht.py | 2 +- homeassistant/components/sensor/efergy.py | 2 +- homeassistant/components/sensor/forecast.py | 2 +- homeassistant/components/sensor/glances.py | 2 +- homeassistant/components/sensor/isy994.py | 2 +- homeassistant/components/sensor/modbus.py | 2 +- homeassistant/components/sensor/mqtt.py | 2 +- homeassistant/components/sensor/mysensors.py | 2 +- .../components/sensor/openweathermap.py | 2 +- homeassistant/components/sensor/rest.py | 2 +- homeassistant/components/sensor/rfxtrx.py | 2 +- homeassistant/components/sensor/rpi_gpio.py | 2 +- homeassistant/components/sensor/sabnzbd.py | 2 +- .../sensor/swiss_public_transport.py | 2 +- .../components/sensor/systemmonitor.py | 2 +- homeassistant/components/sensor/tellstick.py | 2 +- homeassistant/components/sensor/temper.py | 2 +- homeassistant/components/sensor/time_date.py | 2 +- .../components/sensor/transmission.py | 2 +- homeassistant/components/sensor/vera.py | 2 +- homeassistant/components/sensor/verisure.py | 4 +- homeassistant/components/sensor/wink.py | 4 +- homeassistant/components/sensor/worldclock.py | 2 +- homeassistant/components/sensor/zwave.py | 4 +- homeassistant/components/shell_command.py | 2 +- homeassistant/components/simple_alarm.py | 2 +- homeassistant/components/sun.py | 2 +- homeassistant/components/switch/__init__.py | 3 ++ homeassistant/components/switch/arduino.py | 2 +- homeassistant/components/switch/arest.py | 2 +- .../components/switch/command_switch.py | 2 +- homeassistant/components/switch/edimax.py | 2 +- .../components/switch/hikvisioncam.py | 2 +- homeassistant/components/switch/isy994.py | 2 +- homeassistant/components/switch/modbus.py | 2 +- homeassistant/components/switch/mqtt.py | 2 +- homeassistant/components/switch/rest.py | 2 +- homeassistant/components/switch/rfxtrx.py | 2 +- homeassistant/components/switch/rpi_gpio.py | 2 +- homeassistant/components/switch/tellstick.py | 2 +- .../components/switch/transmission.py | 2 +- homeassistant/components/switch/vera.py | 2 +- homeassistant/components/switch/verisure.py | 3 ++ homeassistant/components/switch/wemo.py | 2 +- homeassistant/components/switch/wink.py | 2 +- .../components/thermostat/__init__.py | 4 +- .../components/thermostat/heat_control.py | 3 +- .../components/thermostat/honeywell.py | 9 ++-- homeassistant/components/thermostat/nest.py | 2 +- .../components/thermostat/radiotherm.py | 2 +- homeassistant/components/verisure.py | 2 +- homeassistant/components/wink.py | 2 +- homeassistant/components/zone.py | 4 +- homeassistant/components/zwave.py | 4 +- 136 files changed, 175 insertions(+), 258 deletions(-) diff --git a/homeassistant/components/__init__.py b/homeassistant/components/__init__.py index e5e917c5250..e0b008cab5e 100644 --- a/homeassistant/components/__init__.py +++ b/homeassistant/components/__init__.py @@ -1,7 +1,6 @@ """ homeassistant.components ~~~~~~~~~~~~~~~~~~~~~~~~ - This package contains components that can be plugged into Home Assistant. Component design guidelines: @@ -12,7 +11,6 @@ Each component that tracks states should create state entity names in the format ".". Each component should publish services only under its own domain. - """ import itertools as it import logging diff --git a/homeassistant/components/alarm_control_panel/manual.py b/homeassistant/components/alarm_control_panel/manual.py index 8c98eec50e1..ca1816db9e6 100644 --- a/homeassistant/components/alarm_control_panel/manual.py +++ b/homeassistant/components/alarm_control_panel/manual.py @@ -4,7 +4,7 @@ homeassistant.components.alarm_control_panel.manual Support for manual alarms. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/alarm_control_panel.manual.html +https://home-assistant.io/components/alarm_control_panel.manual/ """ import logging import datetime diff --git a/homeassistant/components/alarm_control_panel/mqtt.py b/homeassistant/components/alarm_control_panel/mqtt.py index e070babd080..168b220db1a 100644 --- a/homeassistant/components/alarm_control_panel/mqtt.py +++ b/homeassistant/components/alarm_control_panel/mqtt.py @@ -4,7 +4,7 @@ homeassistant.components.alarm_control_panel.mqtt This platform enables the possibility to control a MQTT alarm. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/alarm_control_panel.mqtt.html +https://home-assistant.io/components/alarm_control_panel.mqtt/ """ import logging import homeassistant.components.mqtt as mqtt diff --git a/homeassistant/components/alarm_control_panel/verisure.py b/homeassistant/components/alarm_control_panel/verisure.py index 9e0475592bd..e4c498a5044 100644 --- a/homeassistant/components/alarm_control_panel/verisure.py +++ b/homeassistant/components/alarm_control_panel/verisure.py @@ -2,6 +2,9 @@ homeassistant.components.alarm_control_panel.verisure ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Interfaces with Verisure alarm control panel. + +For more details about this platform, please refer to the documentation at +https://home-assistant.io/components/verisure/ """ import logging diff --git a/homeassistant/components/api.py b/homeassistant/components/api.py index 405018938b5..7ccc1f745e9 100644 --- a/homeassistant/components/api.py +++ b/homeassistant/components/api.py @@ -4,7 +4,7 @@ homeassistant.components.api Provides a Rest API for Home Assistant. For more details about the RESTful API, please refer to the documentation at -https://home-assistant.io/developers/api.html +https://home-assistant.io/developers/api/ """ import re import logging diff --git a/homeassistant/components/arduino.py b/homeassistant/components/arduino.py index 12ceafbd44b..0c278ceee63 100644 --- a/homeassistant/components/arduino.py +++ b/homeassistant/components/arduino.py @@ -5,7 +5,7 @@ Arduino component that connects to a directly attached Arduino board which runs with the Firmata firmware. For more details about this component, please refer to the documentation at -https://home-assistant.io/components/arduino.html +https://home-assistant.io/components/arduino/ """ import logging diff --git a/homeassistant/components/automation/__init__.py b/homeassistant/components/automation/__init__.py index b734728e59b..d3ef80d7192 100644 --- a/homeassistant/components/automation/__init__.py +++ b/homeassistant/components/automation/__init__.py @@ -1,8 +1,10 @@ """ homeassistant.components.automation ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - Allows to setup simple automation rules via the config file. + +For more details about this component, please refer to the documentation at +https://home-assistant.io/components/automation/ """ import logging diff --git a/homeassistant/components/automation/event.py b/homeassistant/components/automation/event.py index c172b8e0e11..7fc33df0031 100644 --- a/homeassistant/components/automation/event.py +++ b/homeassistant/components/automation/event.py @@ -4,7 +4,7 @@ homeassistant.components.automation.event Offers event listening automation rules. For more details about this automation rule, please refer to the documentation -at https://home-assistant.io/components/automation.html#event-trigger +at https://home-assistant.io/components/automation/#event-trigger """ import logging diff --git a/homeassistant/components/automation/mqtt.py b/homeassistant/components/automation/mqtt.py index 706d97824b4..8ea5f1bc6e5 100644 --- a/homeassistant/components/automation/mqtt.py +++ b/homeassistant/components/automation/mqtt.py @@ -4,7 +4,7 @@ homeassistant.components.automation.mqtt Offers MQTT listening automation rules. For more details about this automation rule, please refer to the documentation -at https://home-assistant.io/components/automation.html#mqtt-trigger +at https://home-assistant.io/components/automation/#mqtt-trigger """ import logging diff --git a/homeassistant/components/automation/numeric_state.py b/homeassistant/components/automation/numeric_state.py index 1ddfb91a334..ab3529235d6 100644 --- a/homeassistant/components/automation/numeric_state.py +++ b/homeassistant/components/automation/numeric_state.py @@ -1,10 +1,10 @@ """ homeassistant.components.automation.numeric_state -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Offers numeric state listening automation rules. For more details about this automation rule, please refer to the documentation -at https://home-assistant.io/components/automation.html#numeric-state-trigger +at https://home-assistant.io/components/automation/#numeric-state-trigger """ import logging diff --git a/homeassistant/components/automation/state.py b/homeassistant/components/automation/state.py index 52379355d6b..bcf498f509a 100644 --- a/homeassistant/components/automation/state.py +++ b/homeassistant/components/automation/state.py @@ -4,7 +4,7 @@ homeassistant.components.automation.state Offers state listening automation rules. For more details about this automation rule, please refer to the documentation -at https://home-assistant.io/components/automation.html#state-trigger +at https://home-assistant.io/components/automation/#state-trigger """ import logging diff --git a/homeassistant/components/automation/sun.py b/homeassistant/components/automation/sun.py index c72474ae4dd..84334493d0f 100644 --- a/homeassistant/components/automation/sun.py +++ b/homeassistant/components/automation/sun.py @@ -4,7 +4,7 @@ homeassistant.components.automation.sun Offers sun based automation rules. For more details about this automation rule, please refer to the documentation -at https://home-assistant.io/components/automation.html#sun-trigger +at https://home-assistant.io/components/automation/#sun-trigger """ import logging from datetime import timedelta diff --git a/homeassistant/components/automation/time.py b/homeassistant/components/automation/time.py index 2f05c6f4390..7fc2c0d40e2 100644 --- a/homeassistant/components/automation/time.py +++ b/homeassistant/components/automation/time.py @@ -4,7 +4,7 @@ homeassistant.components.automation.time Offers time listening automation rules. For more details about this automation rule, please refer to the documentation -at https://home-assistant.io/components/automation.html#time-trigger +at https://home-assistant.io/components/automation/#time-trigger """ import logging diff --git a/homeassistant/components/automation/zone.py b/homeassistant/components/automation/zone.py index 28d1c8456f0..4bf7eccf41e 100644 --- a/homeassistant/components/automation/zone.py +++ b/homeassistant/components/automation/zone.py @@ -4,7 +4,7 @@ homeassistant.components.automation.zone Offers zone automation rules. For more details about this automation rule, please refer to the documentation -at https://home-assistant.io/components/automation.html#zone-trigger +at https://home-assistant.io/components/automation/#zone-trigger """ import logging diff --git a/homeassistant/components/browser.py b/homeassistant/components/browser.py index c5a55afad40..db0f3710158 100644 --- a/homeassistant/components/browser.py +++ b/homeassistant/components/browser.py @@ -1,8 +1,10 @@ """ homeassistant.components.browser ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - Provides functionality to launch a webbrowser on the host machine. + +For more details about this component, please refer to the documentation at +https://home-assistant.io/components/browser/ """ DOMAIN = "browser" diff --git a/homeassistant/components/camera/__init__.py b/homeassistant/components/camera/__init__.py index e34d4169fa2..01c6c1b6e03 100644 --- a/homeassistant/components/camera/__init__.py +++ b/homeassistant/components/camera/__init__.py @@ -4,24 +4,8 @@ homeassistant.components.camera ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Component to interface with various cameras. -The following features are supported: - - Returning recorded camera images and streams - - Proxying image requests via HA for external access - - Converting a still image url into a live video stream - -Upcoming features - - Recording - - Snapshot - - Motion Detection Recording(for supported cameras) - - Automatic Configuration(for supported cameras) - - Creation of child entities for supported functions - - Collating motion event images passed via FTP into time based events - - A service for calling camera functions - - Camera movement(panning) - - Zoom - - Light/Nightvision toggling - - Support for more devices - - Expanded documentation +For more details about this component, please refer to the documentation at +https://home-assistant.io/components/camera/ """ import requests import logging diff --git a/homeassistant/components/camera/foscam.py b/homeassistant/components/camera/foscam.py index bbcb8eee634..d4d707c790f 100644 --- a/homeassistant/components/camera/foscam.py +++ b/homeassistant/components/camera/foscam.py @@ -4,7 +4,7 @@ homeassistant.components.camera.foscam This component provides basic support for Foscam IP cameras. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/camera.foscam.html +https://home-assistant.io/components/camera.foscam/ """ import logging from homeassistant.helpers import validate_config diff --git a/homeassistant/components/camera/generic.py b/homeassistant/components/camera/generic.py index 74d2d0102d3..55fa4ec913f 100644 --- a/homeassistant/components/camera/generic.py +++ b/homeassistant/components/camera/generic.py @@ -4,7 +4,7 @@ homeassistant.components.camera.generic Support for IP Cameras. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/camera.generic.html +https://home-assistant.io/components/camera.generic/ """ import logging from requests.auth import HTTPBasicAuth diff --git a/homeassistant/components/camera/mjpeg.py b/homeassistant/components/camera/mjpeg.py index 6da1fae7474..1e643304add 100644 --- a/homeassistant/components/camera/mjpeg.py +++ b/homeassistant/components/camera/mjpeg.py @@ -4,7 +4,7 @@ homeassistant.components.camera.mjpeg Support for IP Cameras. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/camera.mjpeg.html +https://home-assistant.io/components/camera.mjpeg/ """ import logging from requests.auth import HTTPBasicAuth @@ -41,10 +41,10 @@ class MjpegCamera(Camera): self._mjpeg_url = device_info['mjpeg_url'] def camera_image(self): - """ Return a still image reponse from the camera. """ + """ Return a still image response from the camera. """ def process_response(response): - """ Take in a response obj, return the jpg from it. """ + """ Take in a response object, return the jpg from it. """ data = b'' for chunk in response.iter_content(1024): data += chunk diff --git a/homeassistant/components/conversation.py b/homeassistant/components/conversation.py index f00a640232f..d9cba832df7 100644 --- a/homeassistant/components/conversation.py +++ b/homeassistant/components/conversation.py @@ -4,7 +4,7 @@ homeassistant.components.conversation Provides functionality to have conversations with Home Assistant. For more details about this component, please refer to the documentation at -https://home-assistant.io/components/conversation.html +https://home-assistant.io/components/conversation/ """ import logging import re diff --git a/homeassistant/components/device_sun_light_trigger.py b/homeassistant/components/device_sun_light_trigger.py index 67da9e26a82..4acf60bc0a2 100644 --- a/homeassistant/components/device_sun_light_trigger.py +++ b/homeassistant/components/device_sun_light_trigger.py @@ -1,9 +1,11 @@ """ homeassistant.components.device_sun_light_trigger ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Provides functionality to turn on lights based on the state of the sun and +devices. -Provides functionality to turn on lights based on -the state of the sun and devices. +For more details about this component, please refer to the documentation at +https://home-assistant.io/components/device_sun_light_trigger/ """ import logging from datetime import timedelta diff --git a/homeassistant/components/device_tracker/__init__.py b/homeassistant/components/device_tracker/__init__.py index 9fe18585418..204d845084c 100644 --- a/homeassistant/components/device_tracker/__init__.py +++ b/homeassistant/components/device_tracker/__init__.py @@ -1,25 +1,10 @@ """ homeassistant.components.device_tracker ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - Provides functionality to keep track of devices. -device_tracker: - platform: netgear - - # Optional - - # How many seconds to wait after not seeing device to consider it not home - consider_home: 180 - - # Seconds between each scan - interval_seconds: 12 - - # New found devices auto found - track_new_devices: yes - - # Maximum distance from home we consider people home - range_home: 100 +For more details about this component, please refer to the documentation at +https://home-assistant.io/components/device_tracker/ """ # pylint: disable=too-many-instance-attributes, too-many-arguments # pylint: disable=too-many-locals diff --git a/homeassistant/components/device_tracker/actiontec.py b/homeassistant/components/device_tracker/actiontec.py index 6296d766456..f363acf1902 100644 --- a/homeassistant/components/device_tracker/actiontec.py +++ b/homeassistant/components/device_tracker/actiontec.py @@ -5,7 +5,7 @@ Device tracker platform that supports scanning an Actiontec MI424WR (Verizon FIOS) router for device presence. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/device_tracker.actiontec.html +https://home-assistant.io/components/device_tracker.actiontec/ """ import logging from datetime import timedelta diff --git a/homeassistant/components/device_tracker/aruba.py b/homeassistant/components/device_tracker/aruba.py index d46264fa264..82183e1495c 100644 --- a/homeassistant/components/device_tracker/aruba.py +++ b/homeassistant/components/device_tracker/aruba.py @@ -5,7 +5,7 @@ Device tracker platform that supports scanning a Aruba Access Point for device presence. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/device_tracker.aruba.html +https://home-assistant.io/components/device_tracker.aruba/ """ import logging from datetime import timedelta diff --git a/homeassistant/components/device_tracker/asuswrt.py b/homeassistant/components/device_tracker/asuswrt.py index 5284d45835b..1bde9a0b376 100644 --- a/homeassistant/components/device_tracker/asuswrt.py +++ b/homeassistant/components/device_tracker/asuswrt.py @@ -4,32 +4,8 @@ homeassistant.components.device_tracker.asuswrt Device tracker platform that supports scanning a ASUSWRT router for device presence. -This device tracker needs telnet to be enabled on the router. - -Configuration: - -To use the ASUSWRT tracker you will need to add something like the following -to your configuration.yaml file. - -device_tracker: - platform: asuswrt - host: YOUR_ROUTER_IP - username: YOUR_ADMIN_USERNAME - password: YOUR_ADMIN_PASSWORD - -Variables: - -host -*Required -The IP address of your router, e.g. 192.168.1.1. - -username -*Required -The username of an user with administrative privileges, usually 'admin'. - -password -*Required -The password for your given admin account. +For more details about this platform, please refer to the documentation at +https://home-assistant.io/components/device_tracker.asuswrt/ """ import logging from datetime import timedelta diff --git a/homeassistant/components/device_tracker/ddwrt.py b/homeassistant/components/device_tracker/ddwrt.py index d8734a55a17..268c4e5a22f 100644 --- a/homeassistant/components/device_tracker/ddwrt.py +++ b/homeassistant/components/device_tracker/ddwrt.py @@ -5,7 +5,7 @@ Device tracker platform that supports scanning a DD-WRT router for device presence. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/device_tracker.ddwrt.html +https://home-assistant.io/components/device_tracker.ddwrt/ """ import logging from datetime import timedelta diff --git a/homeassistant/components/device_tracker/demo.py b/homeassistant/components/device_tracker/demo.py index e8cf906be9e..43b7915ee3c 100644 --- a/homeassistant/components/device_tracker/demo.py +++ b/homeassistant/components/device_tracker/demo.py @@ -1,7 +1,6 @@ """ homeassistant.components.device_tracker.demo ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - Demo platform for the device tracker. device_tracker: diff --git a/homeassistant/components/device_tracker/geofancy.py b/homeassistant/components/device_tracker/geofancy.py index 91d3978326b..a5e6edee71a 100644 --- a/homeassistant/components/device_tracker/geofancy.py +++ b/homeassistant/components/device_tracker/geofancy.py @@ -4,9 +4,8 @@ homeassistant.components.device_tracker.geofancy Geofancy platform for the device tracker. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/device_tracker.geofancy.html +https://home-assistant.io/components/device_tracker.geofancy/ """ - from homeassistant.const import ( HTTP_UNPROCESSABLE_ENTITY, HTTP_INTERNAL_SERVER_ERROR) diff --git a/homeassistant/components/device_tracker/luci.py b/homeassistant/components/device_tracker/luci.py index 2ce032f90fd..8b3e4eeb3c8 100644 --- a/homeassistant/components/device_tracker/luci.py +++ b/homeassistant/components/device_tracker/luci.py @@ -5,7 +5,7 @@ Device tracker platform that supports scanning a OpenWRT router for device presence. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/device_tracker.luci.html +https://home-assistant.io/components/device_tracker.luci/ """ import logging import json diff --git a/homeassistant/components/device_tracker/mqtt.py b/homeassistant/components/device_tracker/mqtt.py index f78cb3420f5..929deaae669 100644 --- a/homeassistant/components/device_tracker/mqtt.py +++ b/homeassistant/components/device_tracker/mqtt.py @@ -4,7 +4,7 @@ homeassistant.components.device_tracker.mqtt MQTT platform for the device tracker. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/device_tracker.mqtt.html +https://home-assistant.io/components/device_tracker.mqtt/ """ import logging from homeassistant import util diff --git a/homeassistant/components/device_tracker/netgear.py b/homeassistant/components/device_tracker/netgear.py index 2d138cf5c70..5d20e98e992 100644 --- a/homeassistant/components/device_tracker/netgear.py +++ b/homeassistant/components/device_tracker/netgear.py @@ -5,7 +5,7 @@ Device tracker platform that supports scanning a Netgear router for device presence. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/device_tracker.netgear.html +https://home-assistant.io/components/device_tracker.netgear/ """ import logging from datetime import timedelta diff --git a/homeassistant/components/device_tracker/nmap_tracker.py b/homeassistant/components/device_tracker/nmap_tracker.py index fe6b814b96f..1e45444c74e 100644 --- a/homeassistant/components/device_tracker/nmap_tracker.py +++ b/homeassistant/components/device_tracker/nmap_tracker.py @@ -4,7 +4,7 @@ homeassistant.components.device_tracker.nmap Device tracker platform that supports scanning a network with nmap. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/device_tracker.nmap_scanner.html +https://home-assistant.io/components/device_tracker.nmap_scanner/ """ import logging from datetime import timedelta diff --git a/homeassistant/components/device_tracker/owntracks.py b/homeassistant/components/device_tracker/owntracks.py index 78fd42f1566..b98c3a1636c 100644 --- a/homeassistant/components/device_tracker/owntracks.py +++ b/homeassistant/components/device_tracker/owntracks.py @@ -4,7 +4,7 @@ homeassistant.components.device_tracker.owntracks OwnTracks platform for the device tracker. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/device_tracker.owntracks.html +https://home-assistant.io/components/device_tracker.owntracks/ """ import json import logging diff --git a/homeassistant/components/device_tracker/snmp.py b/homeassistant/components/device_tracker/snmp.py index 21bcdfb2a93..bf2d7e0a51c 100644 --- a/homeassistant/components/device_tracker/snmp.py +++ b/homeassistant/components/device_tracker/snmp.py @@ -5,7 +5,7 @@ Device tracker platform that supports fetching WiFi associations through SNMP. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/device_tracker.snmp.html +https://home-assistant.io/components/device_tracker.snmp/ """ import logging from datetime import timedelta diff --git a/homeassistant/components/device_tracker/thomson.py b/homeassistant/components/device_tracker/thomson.py index c6679e6c320..657bb910da2 100644 --- a/homeassistant/components/device_tracker/thomson.py +++ b/homeassistant/components/device_tracker/thomson.py @@ -5,7 +5,7 @@ Device tracker platform that supports scanning a THOMSON router for device presence. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/device_tracker.thomson.html +https://home-assistant.io/components/device_tracker.thomson/ """ import logging from datetime import timedelta diff --git a/homeassistant/components/device_tracker/tomato.py b/homeassistant/components/device_tracker/tomato.py index df0c9c8d93d..c87a50f0981 100644 --- a/homeassistant/components/device_tracker/tomato.py +++ b/homeassistant/components/device_tracker/tomato.py @@ -5,7 +5,7 @@ Device tracker platform that supports scanning a Tomato router for device presence. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/device_tracker.tomato.html +https://home-assistant.io/components/device_tracker.tomato/ """ import logging import json diff --git a/homeassistant/components/device_tracker/tplink.py b/homeassistant/components/device_tracker/tplink.py index 3769229f101..46556b3eca4 100755 --- a/homeassistant/components/device_tracker/tplink.py +++ b/homeassistant/components/device_tracker/tplink.py @@ -5,7 +5,7 @@ Device tracker platform that supports scanning a TP-Link router for device presence. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/device_tracker.tplink.html +https://home-assistant.io/components/device_tracker.tplink/ """ import base64 import logging diff --git a/homeassistant/components/device_tracker/ubus.py b/homeassistant/components/device_tracker/ubus.py index 195ed33e77b..0355680a31d 100644 --- a/homeassistant/components/device_tracker/ubus.py +++ b/homeassistant/components/device_tracker/ubus.py @@ -5,7 +5,7 @@ Device tracker platform that supports scanning a OpenWRT router for device presence. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/device_tracker.ubus.html +https://home-assistant.io/components/device_tracker.ubus/ """ import logging import json diff --git a/homeassistant/components/discovery.py b/homeassistant/components/discovery.py index f61d792bc60..3a43c86f58a 100644 --- a/homeassistant/components/discovery.py +++ b/homeassistant/components/discovery.py @@ -1,7 +1,6 @@ """ homeassistant.components.discovery ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - Starts a service to scan in intervals for new devices. Will emit EVENT_PLATFORM_DISCOVERED whenever a new service has been discovered. diff --git a/homeassistant/components/downloader.py b/homeassistant/components/downloader.py index f145fadfb71..a69a6ca1517 100644 --- a/homeassistant/components/downloader.py +++ b/homeassistant/components/downloader.py @@ -4,7 +4,7 @@ homeassistant.components.downloader Provides functionality to download files. For more details about this component, please refer to the documentation at -https://home-assistant.io/components/downloader.html +https://home-assistant.io/components/downloader/ """ import os import logging diff --git a/homeassistant/components/group.py b/homeassistant/components/group.py index 61e77247aa6..9ae83cb734a 100644 --- a/homeassistant/components/group.py +++ b/homeassistant/components/group.py @@ -4,7 +4,7 @@ homeassistant.components.group Provides functionality to group devices that can be turned on or off. For more details about this component, please refer to the documentation at -https://home-assistant.io/components/group.html +https://home-assistant.io/components/group/ """ import homeassistant.core as ha from homeassistant.helpers import generate_entity_id diff --git a/homeassistant/components/history.py b/homeassistant/components/history.py index a2d389a789b..b71f2de7398 100644 --- a/homeassistant/components/history.py +++ b/homeassistant/components/history.py @@ -4,7 +4,7 @@ homeassistant.components.history Provide pre-made queries on top of the recorder component. For more details about this component, please refer to the documentation at -https://home-assistant.io/components/history.html +https://home-assistant.io/components/history/ """ import re from datetime import timedelta diff --git a/homeassistant/components/http.py b/homeassistant/components/http.py index 57e1875cd79..a7ae0c5af6e 100644 --- a/homeassistant/components/http.py +++ b/homeassistant/components/http.py @@ -4,7 +4,7 @@ homeassistant.components.http This module provides an API and a HTTP interface for debug purposes. For more details about the RESTful API, please refer to the documentation at -https://home-assistant.io/developers/api.html +https://home-assistant.io/developers/api/ """ import json import threading diff --git a/homeassistant/components/ifttt.py b/homeassistant/components/ifttt.py index 4a17a5046c6..246265a5268 100644 --- a/homeassistant/components/ifttt.py +++ b/homeassistant/components/ifttt.py @@ -4,7 +4,7 @@ homeassistant.components.ifttt This component enable you to trigger Maker IFTTT recipes. For more details about this component, please refer to the documentation at -https://home-assistant.io/components/ifttt.html +https://home-assistant.io/components/ifttt/ """ import logging import requests diff --git a/homeassistant/components/introduction.py b/homeassistant/components/introduction.py index 5e5dcbd77c2..08a71b27292 100644 --- a/homeassistant/components/introduction.py +++ b/homeassistant/components/introduction.py @@ -4,7 +4,7 @@ homeassistant.components.introduction Component that will help guide the user taking its first steps. For more details about this component, please refer to the documentation at -https://home-assistant.io/components/introduction.html +https://home-assistant.io/components/introduction/ """ import logging diff --git a/homeassistant/components/isy994.py b/homeassistant/components/isy994.py index 63c7b6c4af6..427ef4f048e 100644 --- a/homeassistant/components/isy994.py +++ b/homeassistant/components/isy994.py @@ -5,7 +5,7 @@ Connects to an ISY-994 controller and loads relevant components to control its devices. Also contains the base classes for ISY Sensors, Lights, and Switches. For configuration details please visit the documentation for this component at -https://home-assistant.io/components/isy994.html +https://home-assistant.io/components/isy994/ """ import logging from urllib.parse import urlparse diff --git a/homeassistant/components/keyboard.py b/homeassistant/components/keyboard.py index 6054547d685..ea650d8b421 100644 --- a/homeassistant/components/keyboard.py +++ b/homeassistant/components/keyboard.py @@ -4,7 +4,7 @@ homeassistant.components.keyboard Provides functionality to emulate keyboard presses on host machine. For more details about this component, please refer to the documentation at -https://home-assistant.io/components/keyboard.html +https://home-assistant.io/components/keyboard/ """ import logging diff --git a/homeassistant/components/light/__init__.py b/homeassistant/components/light/__init__.py index 48ae713637d..9fa5f5ea210 100644 --- a/homeassistant/components/light/__init__.py +++ b/homeassistant/components/light/__init__.py @@ -1,56 +1,11 @@ """ homeassistant.components.light ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - Provides functionality to interact with lights. -It offers the following services: - -TURN_OFF - Turns one or multiple lights off. - -Supports following parameters: - - transition - Integer that represents the time the light should take to transition to - the new state. - - entity_id - String or list of strings that point at entity_ids of lights. - -TURN_ON - Turns one or multiple lights on and change attributes. - -Supports following parameters: - - transition - Integer that represents the time the light should take to transition to - the new state. - - - entity_id - String or list of strings that point at entity_ids of lights. - - - profile - String with the name of one of the built-in profiles (relax, energize, - concentrate, reading) or one of the custom profiles defined in - light_profiles.csv in the current working directory. - - Light profiles define a xy color and a brightness. - - If a profile is given and a brightness or xy color then the profile values - will be overwritten. - - - xy_color - A list containing two floats representing the xy color you want the light - to be. - - - rgb_color - A list containing three integers representing the xy color you want the - light to be. - - - color_temp - An INT in mireds represending the color temperature you want the light to be - - - brightness - Integer between 0 and 255 representing how bright you want the light to be. - +For more details about this component, please refer to the documentation at +https://home-assistant.io/components/light/ """ - import logging import os import csv diff --git a/homeassistant/components/light/blinksticklight.py b/homeassistant/components/light/blinksticklight.py index 3e8ba8b505d..086a004eba2 100644 --- a/homeassistant/components/light/blinksticklight.py +++ b/homeassistant/components/light/blinksticklight.py @@ -4,7 +4,7 @@ homeassistant.components.light.blinksticklight Support for Blinkstick lights. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/light.blinksticklight.html +https://home-assistant.io/components/light.blinksticklight/ """ import logging diff --git a/homeassistant/components/light/demo.py b/homeassistant/components/light/demo.py index 0df5706cecd..73da0c51a09 100644 --- a/homeassistant/components/light/demo.py +++ b/homeassistant/components/light/demo.py @@ -1,7 +1,6 @@ """ homeassistant.components.light.demo ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - Demo platform that implements lights. """ diff --git a/homeassistant/components/light/hue.py b/homeassistant/components/light/hue.py index 136c5752ce6..a9c64a36a3f 100644 --- a/homeassistant/components/light/hue.py +++ b/homeassistant/components/light/hue.py @@ -3,7 +3,8 @@ homeassistant.components.light.hue ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Support for Hue lights. -https://home-assistant.io/components/light.hue.html +For more details about this platform, please refer to the documentation at +https://home-assistant.io/components/light.hue/ """ import json import logging diff --git a/homeassistant/components/light/hyperion.py b/homeassistant/components/light/hyperion.py index d5fa3f9f2ce..fe7d504ed4f 100644 --- a/homeassistant/components/light/hyperion.py +++ b/homeassistant/components/light/hyperion.py @@ -3,7 +3,8 @@ homeassistant.components.light.hyperion ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Support for Hyperion remotes. -https://home-assistant.io/components/light.hyperion.html +For more details about this platform, please refer to the documentation at +https://home-assistant.io/components/light.hyperion/ """ import logging import socket diff --git a/homeassistant/components/light/isy994.py b/homeassistant/components/light/isy994.py index 5b62120ee98..6aa604e1b84 100644 --- a/homeassistant/components/light/isy994.py +++ b/homeassistant/components/light/isy994.py @@ -2,6 +2,9 @@ homeassistant.components.light.isy994 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Support for ISY994 lights. + +For more details about this platform, please refer to the documentation at +https://home-assistant.io/components/isy994/ """ import logging diff --git a/homeassistant/components/light/limitlessled.py b/homeassistant/components/light/limitlessled.py index a77fd8937d3..b9789c14862 100644 --- a/homeassistant/components/light/limitlessled.py +++ b/homeassistant/components/light/limitlessled.py @@ -1,18 +1,10 @@ """ homeassistant.components.light.limitlessled ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Support for LimitlessLED bulbs. -Support for LimitlessLED bulbs, also known as... - -- EasyBulb -- AppLight -- AppLamp -- MiLight -- LEDme -- dekolight -- iLight - -https://home-assistant.io/components/light.limitlessled.html +For more details about this platform, please refer to the documentation at +https://home-assistant.io/components/light.limitlessled/ """ import logging diff --git a/homeassistant/components/light/rfxtrx.py b/homeassistant/components/light/rfxtrx.py index d9b32bd2faf..ff52001353b 100644 --- a/homeassistant/components/light/rfxtrx.py +++ b/homeassistant/components/light/rfxtrx.py @@ -4,7 +4,7 @@ homeassistant.components.light.rfxtrx Support for RFXtrx lights. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/light.rfxtrx.html +https://home-assistant.io/components/light.rfxtrx/ """ import logging import homeassistant.components.rfxtrx as rfxtrx diff --git a/homeassistant/components/light/tellstick.py b/homeassistant/components/light/tellstick.py index 22747c4fb04..9a22a4dcdc0 100644 --- a/homeassistant/components/light/tellstick.py +++ b/homeassistant/components/light/tellstick.py @@ -4,7 +4,7 @@ homeassistant.components.light.tellstick Support for Tellstick lights. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/light.tellstick.html +https://home-assistant.io/components/light.tellstick/ """ import logging # pylint: disable=no-name-in-module, import-error diff --git a/homeassistant/components/light/vera.py b/homeassistant/components/light/vera.py index f4c46976626..829d3cfccdb 100644 --- a/homeassistant/components/light/vera.py +++ b/homeassistant/components/light/vera.py @@ -4,7 +4,7 @@ homeassistant.components.light.vera Support for Vera lights. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/light.vera.html +https://home-assistant.io/components/light.vera/ """ import logging import time diff --git a/homeassistant/components/light/wink.py b/homeassistant/components/light/wink.py index 3f3f51be03e..4fbf87aea2d 100644 --- a/homeassistant/components/light/wink.py +++ b/homeassistant/components/light/wink.py @@ -4,7 +4,7 @@ homeassistant.components.light.wink Support for Wink lights. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/light.wink.html +https://home-assistant.io/components/light.wink/ """ import logging diff --git a/homeassistant/components/logbook.py b/homeassistant/components/logbook.py index e81baf4a49c..5c2e7076955 100644 --- a/homeassistant/components/logbook.py +++ b/homeassistant/components/logbook.py @@ -4,7 +4,7 @@ homeassistant.components.logbook Parses events and generates a human log. For more details about this component, please refer to the documentation at -https://home-assistant.io/components/logbook.html +https://home-assistant.io/components/logbook/ """ from datetime import timedelta from itertools import groupby diff --git a/homeassistant/components/logger.py b/homeassistant/components/logger.py index ea12cc0c58b..62396243316 100644 --- a/homeassistant/components/logger.py +++ b/homeassistant/components/logger.py @@ -4,7 +4,7 @@ homeassistant.components.logger Component that will help guide the user taking its first steps. For more details about this component, please refer to the documentation at -https://home-assistant.io/components/logger.html +https://home-assistant.io/components/logger/ Sample configuration diff --git a/homeassistant/components/media_player/__init__.py b/homeassistant/components/media_player/__init__.py index 8040ef9c067..8140bbb2af9 100644 --- a/homeassistant/components/media_player/__init__.py +++ b/homeassistant/components/media_player/__init__.py @@ -1,8 +1,10 @@ """ homeassistant.components.media_player ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - Component to interface with various media players. + +For more details about this component, please refer to the documentation at +https://home-assistant.io/components/media_player/ """ import logging import os diff --git a/homeassistant/components/media_player/cast.py b/homeassistant/components/media_player/cast.py index 175c2e21094..2b343129861 100644 --- a/homeassistant/components/media_player/cast.py +++ b/homeassistant/components/media_player/cast.py @@ -4,7 +4,7 @@ homeassistant.components.media_player.chromecast Provides functionality to interact with Cast devices on the network. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/media_player.cast.html +https://home-assistant.io/components/media_player.cast/ """ import logging diff --git a/homeassistant/components/media_player/denon.py b/homeassistant/components/media_player/denon.py index 4c9065f5289..e8301bc2509 100644 --- a/homeassistant/components/media_player/denon.py +++ b/homeassistant/components/media_player/denon.py @@ -4,7 +4,7 @@ homeassistant.components.media_player.denon Provides an interface to Denon Network Receivers. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/media_player.denon.html +https://home-assistant.io/components/media_player.denon/ """ import telnetlib import logging diff --git a/homeassistant/components/media_player/firetv.py b/homeassistant/components/media_player/firetv.py index 9d712c50c89..1b2c921e3d4 100644 --- a/homeassistant/components/media_player/firetv.py +++ b/homeassistant/components/media_player/firetv.py @@ -4,7 +4,7 @@ homeassistant.components.media_player.firetv Provides functionality to interact with FireTV devices. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/media_player.firetv.html +https://home-assistant.io/components/media_player.firetv/ """ import logging import requests diff --git a/homeassistant/components/media_player/itunes.py b/homeassistant/components/media_player/itunes.py index 40c771d1ea6..275e7d96dee 100644 --- a/homeassistant/components/media_player/itunes.py +++ b/homeassistant/components/media_player/itunes.py @@ -4,7 +4,7 @@ homeassistant.components.media_player.itunes Provides an interface to iTunes API. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/media_player.itunes.html +https://home-assistant.io/components/media_player.itunes/ """ import logging diff --git a/homeassistant/components/media_player/kodi.py b/homeassistant/components/media_player/kodi.py index 8e07ec2df8b..eda143b6cce 100644 --- a/homeassistant/components/media_player/kodi.py +++ b/homeassistant/components/media_player/kodi.py @@ -4,7 +4,7 @@ homeassistant.components.media_player.kodi Provides an interface to the XBMC/Kodi JSON-RPC API For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/media_player.kodi.html +https://home-assistant.io/components/media_player.kodi/ """ import urllib import logging diff --git a/homeassistant/components/media_player/mpd.py b/homeassistant/components/media_player/mpd.py index 6418cbd6e64..8134ce5e743 100644 --- a/homeassistant/components/media_player/mpd.py +++ b/homeassistant/components/media_player/mpd.py @@ -4,7 +4,7 @@ homeassistant.components.media_player.mpd Provides functionality to interact with a Music Player Daemon. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/media_player.mpd.html +https://home-assistant.io/components/media_player.mpd/ """ import logging import socket diff --git a/homeassistant/components/media_player/plex.py b/homeassistant/components/media_player/plex.py index b8267d286d3..6925f942be4 100644 --- a/homeassistant/components/media_player/plex.py +++ b/homeassistant/components/media_player/plex.py @@ -4,7 +4,7 @@ homeassistant.components.media_player.plex Provides an interface to the Plex API. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/media_player.plex.html +https://home-assistant.io/components/media_player.plex/ """ import os import json diff --git a/homeassistant/components/media_player/sonos.py b/homeassistant/components/media_player/sonos.py index 13ee668b18a..87ea9b99efb 100644 --- a/homeassistant/components/media_player/sonos.py +++ b/homeassistant/components/media_player/sonos.py @@ -4,7 +4,7 @@ homeassistant.components.media_player.sonos Provides an interface to Sonos players (via SoCo) For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/media_player.sonos.html +https://home-assistant.io/components/media_player.sonos/ """ import logging import datetime diff --git a/homeassistant/components/media_player/squeezebox.py b/homeassistant/components/media_player/squeezebox.py index b1f3f16567d..86e6addf44a 100644 --- a/homeassistant/components/media_player/squeezebox.py +++ b/homeassistant/components/media_player/squeezebox.py @@ -4,7 +4,7 @@ homeassistant.components.media_player.squeezebox Provides an interface to the Logitech SqueezeBox API For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/media_player.squeezebox.html +https://home-assistant.io/components/media_player.squeezebox/ """ import logging import telnetlib diff --git a/homeassistant/components/modbus.py b/homeassistant/components/modbus.py index 19571518112..099801eb7cf 100644 --- a/homeassistant/components/modbus.py +++ b/homeassistant/components/modbus.py @@ -4,7 +4,7 @@ homeassistant.components.modbus Modbus component, using pymodbus (python3 branch). For more details about this component, please refer to the documentation at -https://home-assistant.io/components/modbus.html +https://home-assistant.io/components/modbus/ """ import logging diff --git a/homeassistant/components/mqtt/__init__.py b/homeassistant/components/mqtt/__init__.py index 69b37ffc94a..cd5b5370175 100644 --- a/homeassistant/components/mqtt/__init__.py +++ b/homeassistant/components/mqtt/__init__.py @@ -4,7 +4,7 @@ homeassistant.components.mqtt MQTT component, using paho-mqtt. For more details about this component, please refer to the documentation at -https://home-assistant.io/components/mqtt.html +https://home-assistant.io/components/mqtt/ """ import logging import os diff --git a/homeassistant/components/recorder.py b/homeassistant/components/recorder.py index c6f7edd6ca8..b09e10f7d92 100644 --- a/homeassistant/components/recorder.py +++ b/homeassistant/components/recorder.py @@ -5,7 +5,7 @@ Component that records all events and state changes. Allows other components to query this database. For more details about this component, please refer to the documentation at -https://home-assistant.io/components/recorder.html +https://home-assistant.io/components/recorder/ """ import logging import threading diff --git a/homeassistant/components/rfxtrx.py b/homeassistant/components/rfxtrx.py index 9c9cf0149e8..3c4675d806d 100644 --- a/homeassistant/components/rfxtrx.py +++ b/homeassistant/components/rfxtrx.py @@ -4,7 +4,7 @@ homeassistant.components.rfxtrx Provides support for RFXtrx components. For more details about this component, please refer to the documentation at -https://home-assistant.io/components/rfxtrx.html +https://home-assistant.io/components/rfxtrx/ """ import logging from homeassistant.util import slugify diff --git a/homeassistant/components/scene.py b/homeassistant/components/scene.py index 48d7389b454..7c96230ccd4 100644 --- a/homeassistant/components/scene.py +++ b/homeassistant/components/scene.py @@ -4,7 +4,7 @@ homeassistant.components.scene Allows users to set and activate scenes. For more details about this component, please refer to the documentation at -https://home-assistant.io/components/scene.html +https://home-assistant.io/components/scene/ """ import logging from collections import namedtuple diff --git a/homeassistant/components/script.py b/homeassistant/components/script.py index 6d5f0ea37a1..3feaff3f903 100644 --- a/homeassistant/components/script.py +++ b/homeassistant/components/script.py @@ -5,7 +5,7 @@ Scripts are a sequence of actions that can be triggered manually by the user or automatically based upon automation events, etc. For more details about this component, please refer to the documentation at -https://home-assistant.io/components/script.html +https://home-assistant.io/components/script/ """ import logging from datetime import timedelta diff --git a/homeassistant/components/sensor/__init__.py b/homeassistant/components/sensor/__init__.py index 90317cdf90a..32ee59a6fa9 100644 --- a/homeassistant/components/sensor/__init__.py +++ b/homeassistant/components/sensor/__init__.py @@ -2,6 +2,9 @@ homeassistant.components.sensor ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Component to interface with various sensors that can be monitored. + +For more details about this component, please refer to the documentation at +https://home-assistant.io/components/sensor/ """ import logging diff --git a/homeassistant/components/sensor/arduino.py b/homeassistant/components/sensor/arduino.py index 61a0890ec10..d4020e465c3 100644 --- a/homeassistant/components/sensor/arduino.py +++ b/homeassistant/components/sensor/arduino.py @@ -5,7 +5,7 @@ Support for getting information from Arduino pins. Only analog pins are supported. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/sensor.arduino.html +https://home-assistant.io/components/sensor.arduino/ """ import logging diff --git a/homeassistant/components/sensor/arest.py b/homeassistant/components/sensor/arest.py index d1533e14798..332725102dd 100644 --- a/homeassistant/components/sensor/arest.py +++ b/homeassistant/components/sensor/arest.py @@ -4,7 +4,7 @@ homeassistant.components.sensor.arest The arest sensor will consume an exposed aREST API of a device. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/sensor.arest.html +https://home-assistant.io/components/sensor.arest/ """ import logging import requests diff --git a/homeassistant/components/sensor/bitcoin.py b/homeassistant/components/sensor/bitcoin.py index 803b9dbb9d4..ca921f4fca7 100644 --- a/homeassistant/components/sensor/bitcoin.py +++ b/homeassistant/components/sensor/bitcoin.py @@ -4,7 +4,7 @@ homeassistant.components.sensor.bitcoin Bitcoin information service that uses blockchain.info and its online wallet. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/sensor.bitcoin.html +https://home-assistant.io/components/sensor.bitcoin/ """ import logging from datetime import timedelta diff --git a/homeassistant/components/sensor/command_sensor.py b/homeassistant/components/sensor/command_sensor.py index 82ac36be500..b5beaab13d0 100644 --- a/homeassistant/components/sensor/command_sensor.py +++ b/homeassistant/components/sensor/command_sensor.py @@ -4,7 +4,7 @@ homeassistant.components.sensor.command_sensor Allows to configure custom shell commands to turn a value for a sensor. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/sensor.command_sensor.html +https://home-assistant.io/components/sensor.command_sensor/ """ import logging import subprocess diff --git a/homeassistant/components/sensor/cpuspeed.py b/homeassistant/components/sensor/cpuspeed.py index ed5d57597d9..1145e35e7a6 100644 --- a/homeassistant/components/sensor/cpuspeed.py +++ b/homeassistant/components/sensor/cpuspeed.py @@ -4,7 +4,7 @@ homeassistant.components.sensor.cpuspeed Shows the current CPU speed. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/sensor.cpuspeed.html +https://home-assistant.io/components/sensor.cpuspeed/ """ import logging diff --git a/homeassistant/components/sensor/dht.py b/homeassistant/components/sensor/dht.py index 218b1b7c3bc..0e39ef7382f 100644 --- a/homeassistant/components/sensor/dht.py +++ b/homeassistant/components/sensor/dht.py @@ -4,7 +4,7 @@ homeassistant.components.sensor.dht Adafruit DHT temperature and humidity sensor. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/sensor.dht.html +https://home-assistant.io/components/sensor.dht/ """ import logging from datetime import timedelta diff --git a/homeassistant/components/sensor/efergy.py b/homeassistant/components/sensor/efergy.py index 7aa33b181dd..99140b5b2a9 100644 --- a/homeassistant/components/sensor/efergy.py +++ b/homeassistant/components/sensor/efergy.py @@ -5,7 +5,7 @@ Monitors home energy use as measured by an efergy engage hub using its (unofficial, undocumented) API. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/sensor.efergy.html +https://home-assistant.io/components/sensor.efergy/ """ import logging from requests import get, RequestException diff --git a/homeassistant/components/sensor/forecast.py b/homeassistant/components/sensor/forecast.py index fd08131cd4f..aa3dd3d3d04 100644 --- a/homeassistant/components/sensor/forecast.py +++ b/homeassistant/components/sensor/forecast.py @@ -4,7 +4,7 @@ homeassistant.components.sensor.forecast Forecast.io weather service. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/sensor.forecast.html +https://home-assistant.io/components/sensor.forecast/ """ import logging from datetime import timedelta diff --git a/homeassistant/components/sensor/glances.py b/homeassistant/components/sensor/glances.py index 0d20c329f41..1ac01e90a22 100644 --- a/homeassistant/components/sensor/glances.py +++ b/homeassistant/components/sensor/glances.py @@ -4,7 +4,7 @@ homeassistant.components.sensor.glances Gathers system information of hosts which running glances. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/sensor.glances.html +https://home-assistant.io/components/sensor.glances/ """ import logging import requests diff --git a/homeassistant/components/sensor/isy994.py b/homeassistant/components/sensor/isy994.py index a97d03fc6aa..9e4ccf4dedb 100644 --- a/homeassistant/components/sensor/isy994.py +++ b/homeassistant/components/sensor/isy994.py @@ -4,7 +4,7 @@ homeassistant.components.sensor.isy994 Support for ISY994 sensors. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/isy994.html +https://home-assistant.io/components/isy994/ """ import logging diff --git a/homeassistant/components/sensor/modbus.py b/homeassistant/components/sensor/modbus.py index 2363022791e..269a9f2dc96 100644 --- a/homeassistant/components/sensor/modbus.py +++ b/homeassistant/components/sensor/modbus.py @@ -4,7 +4,7 @@ homeassistant.components.modbus Support for Modbus sensors. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/sensor.modbus.html +https://home-assistant.io/components/sensor.modbus/ """ import logging diff --git a/homeassistant/components/sensor/mqtt.py b/homeassistant/components/sensor/mqtt.py index 42d94261fb8..2623d2fdcce 100644 --- a/homeassistant/components/sensor/mqtt.py +++ b/homeassistant/components/sensor/mqtt.py @@ -4,7 +4,7 @@ homeassistant.components.sensor.mqtt Allows to configure a MQTT sensor. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/sensor.mqtt.html +https://home-assistant.io/components/sensor.mqtt/ """ import logging from homeassistant.helpers.entity import Entity diff --git a/homeassistant/components/sensor/mysensors.py b/homeassistant/components/sensor/mysensors.py index cb959522134..7c8fbc47e2a 100644 --- a/homeassistant/components/sensor/mysensors.py +++ b/homeassistant/components/sensor/mysensors.py @@ -4,7 +4,7 @@ homeassistant.components.sensor.mysensors Support for MySensors sensors. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/sensor.mysensors.html +https://home-assistant.io/components/sensor.mysensors/ """ import logging diff --git a/homeassistant/components/sensor/openweathermap.py b/homeassistant/components/sensor/openweathermap.py index d4510a0668c..14e8d60c7c6 100644 --- a/homeassistant/components/sensor/openweathermap.py +++ b/homeassistant/components/sensor/openweathermap.py @@ -4,7 +4,7 @@ homeassistant.components.sensor.openweathermap OpenWeatherMap (OWM) service. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/sensor.openweathermap.html +https://home-assistant.io/components/sensor.openweathermap/ """ import logging from datetime import timedelta diff --git a/homeassistant/components/sensor/rest.py b/homeassistant/components/sensor/rest.py index bb368fe9344..7fe3a583b08 100644 --- a/homeassistant/components/sensor/rest.py +++ b/homeassistant/components/sensor/rest.py @@ -4,7 +4,7 @@ homeassistant.components.sensor.rest The rest sensor will consume JSON responses sent by an exposed REST API. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/sensor.rest.html +https://home-assistant.io/components/sensor.rest/ """ import logging import requests diff --git a/homeassistant/components/sensor/rfxtrx.py b/homeassistant/components/sensor/rfxtrx.py index b33206faa29..0118c30ceb6 100644 --- a/homeassistant/components/sensor/rfxtrx.py +++ b/homeassistant/components/sensor/rfxtrx.py @@ -4,7 +4,7 @@ homeassistant.components.sensor.rfxtrx Shows sensor values from RFXtrx sensors. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/sensor.rfxtrx.html +https://home-assistant.io/components/sensor.rfxtrx/ """ import logging from collections import OrderedDict diff --git a/homeassistant/components/sensor/rpi_gpio.py b/homeassistant/components/sensor/rpi_gpio.py index 53039f96409..2e2746fe9d4 100644 --- a/homeassistant/components/sensor/rpi_gpio.py +++ b/homeassistant/components/sensor/rpi_gpio.py @@ -4,7 +4,7 @@ homeassistant.components.sensor.rpi_gpio Allows to configure a binary state sensor using RPi GPIO. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/sensor.rpi_gpio.html +https://home-assistant.io/components/sensor.rpi_gpio/ """ import logging from homeassistant.helpers.entity import Entity diff --git a/homeassistant/components/sensor/sabnzbd.py b/homeassistant/components/sensor/sabnzbd.py index 98fa11d77a1..e478daac2f9 100644 --- a/homeassistant/components/sensor/sabnzbd.py +++ b/homeassistant/components/sensor/sabnzbd.py @@ -4,7 +4,7 @@ homeassistant.components.sensor.sabnzbd Monitors SABnzbd NZB client API. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/sensor.sabnzbd.html +https://home-assistant.io/components/sensor.sabnzbd/ """ from homeassistant.util import Throttle from datetime import timedelta diff --git a/homeassistant/components/sensor/swiss_public_transport.py b/homeassistant/components/sensor/swiss_public_transport.py index ab4f9694739..5edb49870a1 100644 --- a/homeassistant/components/sensor/swiss_public_transport.py +++ b/homeassistant/components/sensor/swiss_public_transport.py @@ -5,7 +5,7 @@ The Swiss public transport sensor will give you the next two departure times from a given location to another one. This sensor is limited to Switzerland. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/sensor.swiss_public_transport.html +https://home-assistant.io/components/sensor.swiss_public_transport/ """ import logging from datetime import timedelta diff --git a/homeassistant/components/sensor/systemmonitor.py b/homeassistant/components/sensor/systemmonitor.py index 1fee6a6328c..110d58283c3 100644 --- a/homeassistant/components/sensor/systemmonitor.py +++ b/homeassistant/components/sensor/systemmonitor.py @@ -4,7 +4,7 @@ homeassistant.components.sensor.systemmonitor Shows system monitor values such as: disk, memory, and processor use. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/sensor.systemmonitor.html +https://home-assistant.io/components/sensor.systemmonitor/ """ import logging diff --git a/homeassistant/components/sensor/tellstick.py b/homeassistant/components/sensor/tellstick.py index ecd991e5413..b6eb42f6dbb 100644 --- a/homeassistant/components/sensor/tellstick.py +++ b/homeassistant/components/sensor/tellstick.py @@ -4,7 +4,7 @@ homeassistant.components.sensor.tellstick Shows sensor values from Tellstick sensors. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/sensor.tellstick.html +https://home-assistant.io/components/sensor.tellstick/ """ import logging from collections import namedtuple diff --git a/homeassistant/components/sensor/temper.py b/homeassistant/components/sensor/temper.py index 712b626406b..d1bbc1cbbeb 100644 --- a/homeassistant/components/sensor/temper.py +++ b/homeassistant/components/sensor/temper.py @@ -4,7 +4,7 @@ homeassistant.components.sensor.temper Support for getting temperature from TEMPer devices. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/sensor.temper.html +https://home-assistant.io/components/sensor.temper/ """ import logging from homeassistant.helpers.entity import Entity diff --git a/homeassistant/components/sensor/time_date.py b/homeassistant/components/sensor/time_date.py index 8f0e4995356..4fff93fd2c0 100644 --- a/homeassistant/components/sensor/time_date.py +++ b/homeassistant/components/sensor/time_date.py @@ -4,7 +4,7 @@ homeassistant.components.sensor.time_date Date and Time service. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/sensor.time_date.html +https://home-assistant.io/components/sensor.time_date/ """ import logging diff --git a/homeassistant/components/sensor/transmission.py b/homeassistant/components/sensor/transmission.py index 8c47f2dbb6f..c4a40e64470 100644 --- a/homeassistant/components/sensor/transmission.py +++ b/homeassistant/components/sensor/transmission.py @@ -4,7 +4,7 @@ homeassistant.components.sensor.transmission Monitors Transmission BitTorrent client API. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/sensor.transmission.html +https://home-assistant.io/components/sensor.transmission/ """ from homeassistant.util import Throttle from datetime import timedelta diff --git a/homeassistant/components/sensor/vera.py b/homeassistant/components/sensor/vera.py index ec8896f5c07..00ad9336705 100644 --- a/homeassistant/components/sensor/vera.py +++ b/homeassistant/components/sensor/vera.py @@ -4,7 +4,7 @@ homeassistant.components.sensor.vera Support for Vera sensors. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/sensor.vera.html +https://home-assistant.io/components/sensor.vera/ """ import logging from requests.exceptions import RequestException diff --git a/homeassistant/components/sensor/verisure.py b/homeassistant/components/sensor/verisure.py index 89c0778ead2..e946be9a3f4 100644 --- a/homeassistant/components/sensor/verisure.py +++ b/homeassistant/components/sensor/verisure.py @@ -3,8 +3,8 @@ homeassistant.components.sensor.verisure ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Interfaces with Verisure sensors. -For more details about the verisure component, please refer to the -documentation at https://home-assistant.io/components/verisure.html +For more details about this platform, please refer to the documentation at +documentation at https://home-assistant.io/components/verisure/ """ import logging diff --git a/homeassistant/components/sensor/wink.py b/homeassistant/components/sensor/wink.py index 6fc3b5abaa5..8bfdb9205fa 100644 --- a/homeassistant/components/sensor/wink.py +++ b/homeassistant/components/sensor/wink.py @@ -3,8 +3,8 @@ homeassistant.components.sensor.wink ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Support for Wink sensors. -For more details about the wink component, please refer to the documentation -at https://home-assistant.io/components/sensor.wink.html +For more details about this platform, please refer to the documentation at +at https://home-assistant.io/components/sensor.wink/ """ import logging diff --git a/homeassistant/components/sensor/worldclock.py b/homeassistant/components/sensor/worldclock.py index 3c15b48ad6a..c7d01578570 100644 --- a/homeassistant/components/sensor/worldclock.py +++ b/homeassistant/components/sensor/worldclock.py @@ -5,7 +5,7 @@ The Worldclock sensor let you display the current time of a different time zone. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/sensor.worldclock.html +https://home-assistant.io/components/sensor.worldclock/ """ import logging diff --git a/homeassistant/components/sensor/zwave.py b/homeassistant/components/sensor/zwave.py index 0cfc0682454..65034f0fb17 100644 --- a/homeassistant/components/sensor/zwave.py +++ b/homeassistant/components/sensor/zwave.py @@ -3,8 +3,8 @@ homeassistant.components.sensor.zwave ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Interfaces with Z-Wave sensors. -For more details about the zwave component, please refer to the documentation -at https://home-assistant.io/components/zwave.html +For more details about this platform, please refer to the documentation +at https://home-assistant.io/components/zwave/ """ # pylint: disable=import-error from homeassistant.helpers.event import track_point_in_time diff --git a/homeassistant/components/shell_command.py b/homeassistant/components/shell_command.py index 493b605091a..61c9add3f23 100644 --- a/homeassistant/components/shell_command.py +++ b/homeassistant/components/shell_command.py @@ -4,7 +4,7 @@ homeassistant.components.shell_command Exposes regular shell commands as services. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/shell_command.html +https://home-assistant.io/components/shell_command/ """ import logging import subprocess diff --git a/homeassistant/components/simple_alarm.py b/homeassistant/components/simple_alarm.py index 9eb9e542cf4..7c45e199dfc 100644 --- a/homeassistant/components/simple_alarm.py +++ b/homeassistant/components/simple_alarm.py @@ -4,7 +4,7 @@ homeassistant.components.simple_alarm Intruder alerts component. For more details about this component, please refer to the documentation at -https://home-assistant.io/components/simple_alarm.html +https://home-assistant.io/components/simple_alarm/ """ import logging diff --git a/homeassistant/components/sun.py b/homeassistant/components/sun.py index 7765f1b7276..a5b83e76929 100644 --- a/homeassistant/components/sun.py +++ b/homeassistant/components/sun.py @@ -4,7 +4,7 @@ homeassistant.components.sun Provides functionality to keep track of the sun. For more details about this component, please refer to the documentation at -https://home-assistant.io/components/sun.html +https://home-assistant.io/components/sun/ """ import logging from datetime import timedelta diff --git a/homeassistant/components/switch/__init__.py b/homeassistant/components/switch/__init__.py index 0fa345747f9..ac4ae533596 100644 --- a/homeassistant/components/switch/__init__.py +++ b/homeassistant/components/switch/__init__.py @@ -2,6 +2,9 @@ homeassistant.components.switch ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Component to interface with various switches that can be controlled remotely. + +For more details about this component, please refer to the documentation +at https://home-assistant.io/components/switch/ """ from datetime import timedelta import logging diff --git a/homeassistant/components/switch/arduino.py b/homeassistant/components/switch/arduino.py index 337fa6c8af3..cf66071ea90 100644 --- a/homeassistant/components/switch/arduino.py +++ b/homeassistant/components/switch/arduino.py @@ -5,7 +5,7 @@ Support for switching Arduino pins on and off. So far only digital pins are supported. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/switch.arduino.html +https://home-assistant.io/components/switch.arduino/ """ import logging diff --git a/homeassistant/components/switch/arest.py b/homeassistant/components/switch/arest.py index c7a7103e7e2..c7bf1b34e4a 100644 --- a/homeassistant/components/switch/arest.py +++ b/homeassistant/components/switch/arest.py @@ -5,7 +5,7 @@ The arest switch can control the digital pins of a device running with the aREST RESTful framework for Arduino, the ESP8266, and the Raspberry Pi. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/switch.arest.html +https://home-assistant.io/components/switch.arest/ """ import logging import requests diff --git a/homeassistant/components/switch/command_switch.py b/homeassistant/components/switch/command_switch.py index 211f1c95600..91171be3680 100644 --- a/homeassistant/components/switch/command_switch.py +++ b/homeassistant/components/switch/command_switch.py @@ -4,7 +4,7 @@ homeassistant.components.switch.command_switch Allows to configure custom shell commands to turn a switch on/off. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/switch.command_switch.html +https://home-assistant.io/components/switch.command_switch/ """ import logging import subprocess diff --git a/homeassistant/components/switch/edimax.py b/homeassistant/components/switch/edimax.py index 68542094526..6d4d7d1f3a0 100644 --- a/homeassistant/components/switch/edimax.py +++ b/homeassistant/components/switch/edimax.py @@ -4,7 +4,7 @@ homeassistant.components.switch.edimax Support for Edimax switches. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/switch.edimax.html +https://home-assistant.io/components/switch.edimax/ """ import logging diff --git a/homeassistant/components/switch/hikvisioncam.py b/homeassistant/components/switch/hikvisioncam.py index 41def00daa2..ec74a83dbc2 100644 --- a/homeassistant/components/switch/hikvisioncam.py +++ b/homeassistant/components/switch/hikvisioncam.py @@ -4,7 +4,7 @@ homeassistant.components.switch.hikvision Support turning on/off motion detection on Hikvision cameras. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/switch.hikvision.html +https://home-assistant.io/components/switch.hikvision/ """ from homeassistant.helpers.entity import ToggleEntity from homeassistant.const import STATE_ON, STATE_OFF diff --git a/homeassistant/components/switch/isy994.py b/homeassistant/components/switch/isy994.py index 5fb516d0690..c8a04a66709 100644 --- a/homeassistant/components/switch/isy994.py +++ b/homeassistant/components/switch/isy994.py @@ -4,7 +4,7 @@ homeassistant.components.switch.isy994 Support for ISY994 switches. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/isy994.html +https://home-assistant.io/components/isy994/ """ import logging diff --git a/homeassistant/components/switch/modbus.py b/homeassistant/components/switch/modbus.py index 1273f85f356..d802877b988 100644 --- a/homeassistant/components/switch/modbus.py +++ b/homeassistant/components/switch/modbus.py @@ -4,7 +4,7 @@ homeassistant.components.switch.modbus Support for Modbus switches. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/switch.modbus.html +https://home-assistant.io/components/switch.modbus/ """ import logging diff --git a/homeassistant/components/switch/mqtt.py b/homeassistant/components/switch/mqtt.py index b8a550dba70..12d3f486323 100644 --- a/homeassistant/components/switch/mqtt.py +++ b/homeassistant/components/switch/mqtt.py @@ -4,7 +4,7 @@ homeassistant.components.switch.mqtt Allows to configure a MQTT switch. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/switch.mqtt.html +https://home-assistant.io/components/switch.mqtt/ """ import logging import homeassistant.components.mqtt as mqtt diff --git a/homeassistant/components/switch/rest.py b/homeassistant/components/switch/rest.py index b81bfc246b4..2435829637e 100644 --- a/homeassistant/components/switch/rest.py +++ b/homeassistant/components/switch/rest.py @@ -4,7 +4,7 @@ homeassistant.components.switch.rest Allows to configure a REST switch. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/switch.rest.html +https://home-assistant.io/components/switch.rest/ """ import logging import requests diff --git a/homeassistant/components/switch/rfxtrx.py b/homeassistant/components/switch/rfxtrx.py index 5654725e6b0..83100598245 100644 --- a/homeassistant/components/switch/rfxtrx.py +++ b/homeassistant/components/switch/rfxtrx.py @@ -4,7 +4,7 @@ homeassistant.components.switch.rfxtrx Support for RFXtrx switches. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/switch.rfxtrx.html +https://home-assistant.io/components/switch.rfxtrx/ """ import logging import homeassistant.components.rfxtrx as rfxtrx diff --git a/homeassistant/components/switch/rpi_gpio.py b/homeassistant/components/switch/rpi_gpio.py index 9dbb8380b94..1c36aa262f4 100644 --- a/homeassistant/components/switch/rpi_gpio.py +++ b/homeassistant/components/switch/rpi_gpio.py @@ -4,7 +4,7 @@ homeassistant.components.switch.rpi_gpio Allows to control the GPIO pins of a Raspberry Pi. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/switch.rpi_gpio.html +https://home-assistant.io/components/switch.rpi_gpio/ """ import logging try: diff --git a/homeassistant/components/switch/tellstick.py b/homeassistant/components/switch/tellstick.py index 4bff2c8592c..2966673520f 100644 --- a/homeassistant/components/switch/tellstick.py +++ b/homeassistant/components/switch/tellstick.py @@ -4,7 +4,7 @@ homeassistant.components.switch.tellstick Support for Tellstick switches. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/switch.tellstick.html +https://home-assistant.io/components/switch.tellstick/ """ import logging diff --git a/homeassistant/components/switch/transmission.py b/homeassistant/components/switch/transmission.py index 96f4a47483b..bb4f6616975 100644 --- a/homeassistant/components/switch/transmission.py +++ b/homeassistant/components/switch/transmission.py @@ -4,7 +4,7 @@ homeassistant.components.switch.transmission Enable or disable Transmission BitTorrent client Turtle Mode. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/switch.transmission.html +https://home-assistant.io/components/switch.transmission/ """ from homeassistant.const import CONF_HOST, CONF_USERNAME, CONF_PASSWORD from homeassistant.const import STATE_ON, STATE_OFF diff --git a/homeassistant/components/switch/vera.py b/homeassistant/components/switch/vera.py index 51d682bcdc1..80724f92757 100644 --- a/homeassistant/components/switch/vera.py +++ b/homeassistant/components/switch/vera.py @@ -4,7 +4,7 @@ homeassistant.components.switch.vera Support for Vera switches. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/switch.vera.html +https://home-assistant.io/components/switch.vera/ """ import logging import time diff --git a/homeassistant/components/switch/verisure.py b/homeassistant/components/switch/verisure.py index 7840defdfc4..a2893df76dd 100644 --- a/homeassistant/components/switch/verisure.py +++ b/homeassistant/components/switch/verisure.py @@ -2,6 +2,9 @@ homeassistant.components.switch.verisure ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Support for Verisure Smartplugs. + +For more details about this platform, please refer to the documentation at +documentation at https://home-assistant.io/components/verisure/ """ import logging diff --git a/homeassistant/components/switch/wemo.py b/homeassistant/components/switch/wemo.py index 8781b5adf0f..1d701bf88cc 100644 --- a/homeassistant/components/switch/wemo.py +++ b/homeassistant/components/switch/wemo.py @@ -4,7 +4,7 @@ homeassistant.components.switch.wemo Support for WeMo switches. For more details about this component, please refer to the documentation at -https://home-assistant.io/components/switch.wemo.html +https://home-assistant.io/components/switch.wemo/ """ import logging diff --git a/homeassistant/components/switch/wink.py b/homeassistant/components/switch/wink.py index 05d431c16f2..b022d8cbf72 100644 --- a/homeassistant/components/switch/wink.py +++ b/homeassistant/components/switch/wink.py @@ -4,7 +4,7 @@ homeassistant.components.switch.wink Support for Wink switches. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/switch.wink.html +https://home-assistant.io/components/switch.wink/ """ import logging diff --git a/homeassistant/components/thermostat/__init__.py b/homeassistant/components/thermostat/__init__.py index 89f00da3318..480e3e4805e 100644 --- a/homeassistant/components/thermostat/__init__.py +++ b/homeassistant/components/thermostat/__init__.py @@ -1,8 +1,10 @@ """ homeassistant.components.thermostat ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - Provides functionality to interact with thermostats. + +For more details about this component, please refer to the documentation at +https://home-assistant.io/components/thermostat/ """ import logging import os diff --git a/homeassistant/components/thermostat/heat_control.py b/homeassistant/components/thermostat/heat_control.py index 681b016b108..7080528fd17 100644 --- a/homeassistant/components/thermostat/heat_control.py +++ b/homeassistant/components/thermostat/heat_control.py @@ -1,9 +1,10 @@ """ homeassistant.components.thermostat.heat_control ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Adds support for heat control units. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/thermostat.heat_control.html +https://home-assistant.io/components/thermostat.heat_control/ """ import logging diff --git a/homeassistant/components/thermostat/honeywell.py b/homeassistant/components/thermostat/honeywell.py index 4c2a1cb8093..56880c4eded 100644 --- a/homeassistant/components/thermostat/honeywell.py +++ b/homeassistant/components/thermostat/honeywell.py @@ -1,7 +1,10 @@ """ -homeassistant.components.thermostat.honeywell_round_connected -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +homeassistant.components.thermostat.honeywell +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Adds support for Honeywell Round Connected thermostats. + +For more details about this platform, please refer to the documentation at +https://home-assistant.io/components/thermostat.honeywell/ """ import socket import logging @@ -76,7 +79,7 @@ class RoundThermostat(ThermostatDevice): data = next(self.device.temperatures(force_refresh=True)) except StopIteration: _LOGGER.error("Did not receive any temperature data from the " - "evohomeclient api.") + "evohomeclient API.") return self._current_temperature = data['temp'] diff --git a/homeassistant/components/thermostat/nest.py b/homeassistant/components/thermostat/nest.py index 4179d1a1c70..f38935b726e 100644 --- a/homeassistant/components/thermostat/nest.py +++ b/homeassistant/components/thermostat/nest.py @@ -4,7 +4,7 @@ homeassistant.components.thermostat.nest Adds support for Nest thermostats. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/thermostat.nest.html +https://home-assistant.io/components/thermostat.nest/ """ import socket import logging diff --git a/homeassistant/components/thermostat/radiotherm.py b/homeassistant/components/thermostat/radiotherm.py index 351ba387cb7..748d0421acd 100644 --- a/homeassistant/components/thermostat/radiotherm.py +++ b/homeassistant/components/thermostat/radiotherm.py @@ -4,7 +4,7 @@ homeassistant.components.thermostat.radiotherm Adds support for Radio Thermostat wifi-enabled home thermostats. For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/thermostat.radiotherm.html +https://home-assistant.io/components/thermostat.radiotherm/ """ import logging import datetime diff --git a/homeassistant/components/verisure.py b/homeassistant/components/verisure.py index 6d4158aca15..837acbd18ae 100644 --- a/homeassistant/components/verisure.py +++ b/homeassistant/components/verisure.py @@ -4,7 +4,7 @@ components.verisure Provides support for verisure components. For more details about this component, please refer to the documentation at -https://home-assistant.io/components/verisure.html +https://home-assistant.io/components/verisure/ """ import logging from datetime import timedelta diff --git a/homeassistant/components/wink.py b/homeassistant/components/wink.py index 524280acadd..03601f1d958 100644 --- a/homeassistant/components/wink.py +++ b/homeassistant/components/wink.py @@ -4,7 +4,7 @@ homeassistant.components.wink Connects to a Wink hub and loads relevant components to control its devices. For more details about this component, please refer to the documentation at -https://home-assistant.io/components/wink.html +https://home-assistant.io/components/wink/ """ import logging diff --git a/homeassistant/components/zone.py b/homeassistant/components/zone.py index e978d963c5a..a32a297caeb 100644 --- a/homeassistant/components/zone.py +++ b/homeassistant/components/zone.py @@ -3,8 +3,8 @@ homeassistant.components.zone ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Allows defintion of zones in Home Assistant. -For configuration details please visit the documentation for this component at -https://home-assistant.io/components/zone.html +For more details about this component, please refer to the documentation at +https://home-assistant.io/components/zone/ """ import logging diff --git a/homeassistant/components/zwave.py b/homeassistant/components/zwave.py index 9f7df64312d..daa323c6378 100644 --- a/homeassistant/components/zwave.py +++ b/homeassistant/components/zwave.py @@ -3,8 +3,8 @@ homeassistant.components.zwave ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Connects Home Assistant to a Z-Wave network. -For configuration details please visit the documentation for this component at -https://home-assistant.io/components/zwave.html +For more details about this component, please refer to the documentation at +https://home-assistant.io/components/zwave/ """ from pprint import pprint