Skip to content

docs: expose public package surface in API overview #103

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Faerkeren merged 1 commit into from
May 28, 2026
Merged

docs: expose public package surface in API overview #103

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions docs/reference/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,41 @@
# API Reference

The `haclient` package re-exports its public API at the top level. The
table below maps every name in `haclient.__all__` to the reference page
where it is documented.

## Public exports

| Name | Kind | Reference |
| --- | --- | --- |
| `HAClient` | Async client facade | [HAClient (facade)](api.md) |
| `SyncHAClient` | Blocking wrapper | [Sync Client](sync.md) |
| `ConnectionConfig` | Configuration | [Configuration](config.md) |
| `ServicePolicy` | Configuration | [Configuration](config.md) |
| `Entity` | Entity base class | [Entity](entity.md) |
| `Connection` | Core | [Connection](core/connection.md) |
| `EventBus` | Core | [Event Bus](core/events.md) |
| `ServiceCaller` | Core | [Service Caller](core/services.md) |
| `StateStore` | Core | [State Store](core/state.md) |
| `EntityRegistry` | Core | [Entity Registry](core/registry.md) |
| `EntityFactory` | Core | [Entity Factory](core/factory.md) |
| `DomainAccessor` | Plugins | [Plugins](core/plugins.md) |
| `DomainRegistry` | Plugins | [Plugins](core/plugins.md) |
| `DomainSpec` | Plugins | [Plugins](core/plugins.md) |
| `register_domain` | Plugins | [Plugins](core/plugins.md) |
| `Clock` | Port protocol | [Ports](ports.md) |
| `RestPort` | Port protocol | [Ports](ports.md) |
| `WebSocketPort` | Port protocol | [Ports](ports.md) |
| `HAClientError` | Exception | [Exceptions](exceptions.md) |
| `AuthenticationError` | Exception | [Exceptions](exceptions.md) |
| `CommandError` | Exception | [Exceptions](exceptions.md) |
| `ConnectionClosedError` | Exception | [Exceptions](exceptions.md) |
| `EntityNotFoundError` | Exception | [Exceptions](exceptions.md) |
| `HTTPError` | Exception | [Exceptions](exceptions.md) |
| `TimeoutError` | Exception | [Exceptions](exceptions.md) |

## Package

::: haclient
options:
show_submodules: false
Expand Down
Loading