Merge pull request #25 from graphras-com/docs/mkdocs-setup

Add MkDocs documentation with mkdocstrings

Author: Faerkeren

docs/index.md

@@ -0,0 +1,48 @@
+# HaClient
+
+Async-first, high-level Python client for Home Assistant with REST and WebSocket support.
+
+## Features
+
+- Async context manager with automatic WebSocket connection and state priming
+- Typed domain accessors: light, switch, climate, cover, sensor, binary sensor, media player
+- Real-time state change listeners with granular filtering
+- Synchronous blocking wrapper for scripts, REPL, and Jupyter
+- Automatic WebSocket reconnection with exponential backoff
+- Fully typed (PEP 561) with strict mypy enforcement
+
+## Installation
+
+```bash
+pip install haclient
+```
+
+Or install from source:
+
+```bash
+git clone https://github.com/graphras-com/HaClient.git
+cd HaClient
+pip install .
+```
+
+## Quick Start
+
+### Async
+
+```python
+from haclient import HAClient
+
+async with HAClient("http://localhost:8123", token="YOUR_TOKEN") as ha:
+    light = ha.light("kitchen")
+    await light.turn_on(brightness=200)
+```
+
+### Synchronous
+
+```python
+from haclient import SyncHAClient
+
+with SyncHAClient("http://localhost:8123", token="YOUR_TOKEN") as ha:
+    light = ha.light("kitchen")
+    light.turn_on(brightness=200)
+```

docs/reference/client.md

@@ -0,0 +1,3 @@
+# Client
+
+::: haclient.client

docs/reference/domains/binary_sensor.md

@@ -0,0 +1,3 @@
+# Binary Sensor
+
+::: haclient.domains.binary_sensor

docs/reference/domains/climate.md

@@ -0,0 +1,3 @@
+# Climate
+
+::: haclient.domains.climate

docs/reference/domains/cover.md

@@ -0,0 +1,3 @@
+# Cover
+
+::: haclient.domains.cover

docs/reference/domains/light.md

@@ -0,0 +1,3 @@
+# Light
+
+::: haclient.domains.light

docs/reference/domains/media_player.md

@@ -0,0 +1,3 @@
+# Media Player
+
+::: haclient.domains.media_player

docs/reference/domains/sensor.md

@@ -0,0 +1,3 @@
+# Sensor
+
+::: haclient.domains.sensor

docs/reference/domains/switch.md

@@ -0,0 +1,3 @@
+# Switch
+
+::: haclient.domains.switch

docs/reference/entity.md

@@ -0,0 +1,3 @@
+# Entity
+
+::: haclient.entity