Skip to content

Commit c6e424d

Browse files
authored
Merge pull request #103 from graphras-com/docs/expose-public-api-overview
docs: expose public package surface in API overview
2 parents 69b2e83 + 3091d02 commit c6e424d

1 file changed

Lines changed: 36 additions & 0 deletions

File tree

docs/reference/index.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,41 @@
11
# API Reference
22

3+
The `haclient` package re-exports its public API at the top level. The
4+
table below maps every name in `haclient.__all__` to the reference page
5+
where it is documented.
6+
7+
## Public exports
8+
9+
| Name | Kind | Reference |
10+
| --- | --- | --- |
11+
| `HAClient` | Async client facade | [HAClient (facade)](api.md) |
12+
| `SyncHAClient` | Blocking wrapper | [Sync Client](sync.md) |
13+
| `ConnectionConfig` | Configuration | [Configuration](config.md) |
14+
| `ServicePolicy` | Configuration | [Configuration](config.md) |
15+
| `Entity` | Entity base class | [Entity](entity.md) |
16+
| `Connection` | Core | [Connection](core/connection.md) |
17+
| `EventBus` | Core | [Event Bus](core/events.md) |
18+
| `ServiceCaller` | Core | [Service Caller](core/services.md) |
19+
| `StateStore` | Core | [State Store](core/state.md) |
20+
| `EntityRegistry` | Core | [Entity Registry](core/registry.md) |
21+
| `EntityFactory` | Core | [Entity Factory](core/factory.md) |
22+
| `DomainAccessor` | Plugins | [Plugins](core/plugins.md) |
23+
| `DomainRegistry` | Plugins | [Plugins](core/plugins.md) |
24+
| `DomainSpec` | Plugins | [Plugins](core/plugins.md) |
25+
| `register_domain` | Plugins | [Plugins](core/plugins.md) |
26+
| `Clock` | Port protocol | [Ports](ports.md) |
27+
| `RestPort` | Port protocol | [Ports](ports.md) |
28+
| `WebSocketPort` | Port protocol | [Ports](ports.md) |
29+
| `HAClientError` | Exception | [Exceptions](exceptions.md) |
30+
| `AuthenticationError` | Exception | [Exceptions](exceptions.md) |
31+
| `CommandError` | Exception | [Exceptions](exceptions.md) |
32+
| `ConnectionClosedError` | Exception | [Exceptions](exceptions.md) |
33+
| `EntityNotFoundError` | Exception | [Exceptions](exceptions.md) |
34+
| `HTTPError` | Exception | [Exceptions](exceptions.md) |
35+
| `TimeoutError` | Exception | [Exceptions](exceptions.md) |
36+
37+
## Package
38+
339
::: haclient
440
options:
541
show_submodules: false

0 commit comments

Comments
 (0)