Continue working on the docs...

Author: GrandMoff100

docs/api.rst

@@ -1,7 +1,80 @@
 Code Reference
 ***************
 
-.. automodule:: homeassistant_api
-      :platform: Linux, Windows, MacOS
-      :inherited-members:
-      :exclude-members: model_json_schema, model_copy, model_rebuild, model_dump, construct, copy, dict, from_orm, json, parse_file, model_validate, parse_raw, parse_obj, parse_str, parse_url, schema, schema_json, schema_yaml, schema_yml, to_orm, update_forward_refs, validate, validate_file, validate_obj, validate_raw, validate_str, validate_url, model_validate_strings, model_validate_json, model_validate, model_post_init, model_parametrized_name, model_extra, model_fields_set, model_dump_json, model_construct, model_computed_fields
+Here you can find a detailed reference for most classes and methods in the library.
+
+
+Clients
+=======
+
+.. autoclass:: homeassistant_api.Client
+   :members:
+
+
+.. autoclass:: homeassistant_api.AsyncClient
+   :members:
+
+
+.. autoclass:: homeassistant_api.WebsocketClient
+   :members:
+
+
+Data Models
+===========
+
+
+Domains
+--------
+
+.. automodule:: homeassistant_api.models.domains
+   :members:
+
+Entities
+--------
+
+.. automodule:: homeassistant_api.models.entity
+   :members:
+
+
+Events
+-------
+
+.. automodule:: homeassistant_api.models.events
+   :members:
+
+History
+--------
+
+.. automodule:: homeassistant_api.models.history
+   :members:
+
+Logbook
+--------
+
+.. automodule:: homeassistant_api.models.logbook
+   :members:
+
+Entity States
+--------------
+
+.. automodule:: homeassistant_api.models.states
+   :members:
+
+Websocket Models
+----------------
+
+.. automodule:: homeassistant_api.models.websocket
+   :members:
+   
+Request Processing
+==================
+
+.. automodule:: homeassistant_api.processing
+   :members:
+
+
+Errors
+=======
+
+.. automodule:: homeassistant_api.errors
+   :members:

docs/conf.py

@@ -15,13 +15,14 @@
 import re
 import sys
 
+
 sys.path.insert(0, os.path.abspath("../"))
 sys.path.append(os.path.abspath("extensions"))
 
 # -- Project information -----------------------------------------------------
 
 project = "Homeassistant API"
-copyright = "2023-2025, Nathan Larsen"  # pylint: disable=redefined-builtin
+copyright = "2023-2026, Nathan Larsen"  # pylint: disable=redefined-builtin
 author = "Nathan Larsen"
 repo_url = "https://github.com/GrandMoff100/HomeassistantAPI"
 
@@ -50,6 +51,8 @@
 ]
 
 autodoc_pydantic_model_show_json = False
+autodoc_pydantic_model_show_config = False
+
 
 resource_links = {
     "repo": repo_url,
@@ -86,11 +89,15 @@
 autodoc_default_options = {
     "members": True,
     "member-order": "bysource",
+    "exclude-members": "model_config",
 }
 intersphinx_mapping = {
-    "python": (
-        "https://docs.python.org/3",
-        None,
-    ),
+    "python": ("https://docs.python.org/3", None),
     "homeassistant_api": ("https://homeassistantapi.readthedocs.io/en/stable", None),
+    "niquests": ("https://niquests.readthedocs.io/en/stable", None),
+    "niquests-cache": ("https://niquests-cache.readthedocs.io/en/stable/", None)
 }
+
+autodoc_type_aliases = {
+    "JsonValue": "typing.Any",
+}

docs/quickstart.rst

@@ -6,7 +6,7 @@ Prerequisites
 ==============
 
 1. Homeassistant
----------------
+----------------
 Before using this library, you need to have Home Assistant running on a device.
 Something like a `Raspberry Pi 3 or 4 <https://www.raspberrypi.com>`_ or spare laptop.
 If you don't want to do that you can setup a Home Assistant container on your laptop or desktop with docker.
@@ -27,15 +27,15 @@ If you are not sure if it is enabled or not, chances are if your frontend is ena
 .. _access_token_setup:
 
 2. Access Token
---------------
+---------------
 Then once you have done that you need to head over to your profile and set up a "Long Lived Access Token" to use in your code later.
 A good guide on how to do that is `here <https://www.home-assistant.io/docs/authentication/#your-account-profile>`__
 Also if you are building a website and want to integrate Home Assistant you can use a refresh token instead.
 See their `Authentication API docs <https://developers.home-assistant.io/docs/auth_api/>`__ for more information.
 Every time you refresh your token you will need to update the :py:attr:`Client.token` attribute of your :py:class:`Client` instance.
 
 3. Exposing Home Assistant to the Web (optional)
---------------------------------------
+------------------------------------------------
 You may want to setup remote access through a Dynamic DNS server like DuckDNS (a good youtube tutorial on how to do that
 `here <https://www.youtube.com/watch?v=AK5E2T5tWyM>`__, keep in mind you will need to port forward to set that up.)
 If you do pursue this your API URL will be something like :code:`https://yourhomeassistant.duckdns.org:8123/api`.
@@ -47,7 +47,7 @@ Installation
 There are a variety of our different ways you can install the library.
 
 Installing with :code:`pip` (recommended)
------------------------------------
+-----------------------------------------
 
 Installation with pip is really easy and will install the dependencies this project needs.
 This installs the latest stable version from :resource:`PyPI <pypi>`

homeassistant_api/__init__.py

@@ -11,11 +11,13 @@
     "AuthInvalid",
     "AuthOk",
     "AuthRequired",
+    "BaseClient",
     "BaseDomain",
     "BaseEntity",
     "BaseEvent",
     "BaseGroup",
     "BaseService",
+    "BaseWebsocketClient",
     "Client",
     "ConfigEntry",
     "ConfigEntryChange",
@@ -51,10 +53,13 @@
     "ServiceField",
     "State",
     "WebsocketClient",
+    "WebsocketClient",
 )
 
 from .asyncclient import AsyncClient
 from .asyncwebsocket import AsyncWebsocketClient
+from .baseclient import BaseClient
+from .basewebsocket import BaseWebsocketClient
 from .client import Client
 from .models.config_entries import ConfigEntry
 from .models.config_entries import ConfigEntryChange

homeassistant_api/client.py

@@ -44,7 +44,7 @@ class Client(BaseClient):
     :param token: The refresh or long lived access token to authenticate your requests. Required.
     :param session: A custom :py:class:`niquests.Session` instance. Optional.
     :param verify_ssl: Whether to verify SSL certificates. Default :code:`True`.
-    :param global_request_kwargs: Kwargs to pass to :func:`requests.request`. Optional.
+    :param global_request_kwargs: Kwargs to pass to :py:meth:`niquests.Session.request`. Optional.
     """  # pylint: disable=line-too-long
 
     _session: Session

homeassistant_api/models/domains.py

@@ -24,6 +24,15 @@
 
     from .states import State
 
+__all__ = (
+    "AsyncDomain",
+    "BaseDomain",
+    "Domain",
+    "BaseService",
+    "AsyncService",
+    "Service"
+)
+
 
 class BaseDomain(BaseModel):
     """Model representing the domain that services belong to."""
@@ -64,7 +73,7 @@ def _add_service(self, service_id: str, **data: Any) -> None:
         raise NotImplementedError
 
     def get_service(self, service_id: str) -> BaseService | None:
-        """Return a Service with the given service_id, returns None if no such service exists"""
+        """Return a Service with the given :code:`service_id`, returns None if no such service exists"""
         return self.services.get(service_id)
 
     def __getattr__(self, attr: str) -> Any: