HaClient/mkdocs.yml at main · graphras-com/HaClient · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
site_name: HaClient
site_description: Async-first, high-level Python client for Home Assistant
repo_url: https://github.com/graphras-com/HaClient

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

nav:
  - Home: index.md
  - Architecture: architecture.md
  - Guides:
      - Overview: guides/index.md
      - Async lifecycle: guides/lifecycle.md
      - Sync wrapper: guides/sync-wrapper.md
      - State and value listeners: guides/listeners.md
      - Reconnect handling: guides/reconnect.md
      - Custom domains and plugins: guides/custom-domains.md
      - Service routing (advanced): guides/service-routing.md
      - Domain workflows:
          - Light: guides/domains/light.md
          - Switch: guides/domains/switch.md
          - Climate: guides/domains/climate.md
          - Cover: guides/domains/cover.md
          - Media Player: guides/domains/media_player.md
          - Scene: guides/domains/scene.md
          - Timer: guides/domains/timer.md
          - Sensor: guides/domains/sensor.md
  - API Reference:
      - Overview: reference/index.md
      - HAClient (facade): reference/api.md
      - Sync Client: reference/sync.md
      - Configuration: reference/config.md
      - Ports: reference/ports.md
      - Entity: reference/entity.md
      - Exceptions: reference/exceptions.md
      - Core:
          - Connection: reference/core/connection.md
          - Event Bus: reference/core/events.md
          - Service Caller: reference/core/services.md
          - State Store: reference/core/state.md
          - Entity Registry: reference/core/registry.md
          - Entity Factory: reference/core/factory.md
          - Plugins: reference/core/plugins.md
          - Clock: reference/core/clock.md
      - Infrastructure:
          - REST adapter: reference/infra/rest_aiohttp.md
          - WebSocket adapter: reference/infra/ws_aiohttp.md
      - Domains:
          - Air Quality: reference/domains/air_quality.md
          - Binary Sensor: reference/domains/binary_sensor.md
          - Climate: reference/domains/climate.md
          - Cover: reference/domains/cover.md
          - Event: reference/domains/event.md
          - Fan: reference/domains/fan.md
          - Humidifier: reference/domains/humidifier.md
          - Light: reference/domains/light.md
          - Lock: reference/domains/lock.md
          - Media Player: reference/domains/media_player.md
          - Scene: reference/domains/scene.md
          - Sensor: reference/domains/sensor.md
          - Switch: reference/domains/switch.md
          - Timer: reference/domains/timer.md
          - Vacuum: reference/domains/vacuum.md
          - Valve: reference/domains/valve.md

hooks:
  - tools/mkdocs_hooks.py

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: ["src"]
          options:
            docstring_style: numpy
            show_source: true
            show_signature_annotations: true
            separate_signature: true
            members_order: source
            show_root_heading: true
            show_root_full_path: false