adapt docs

enlyze · Aug 16, 2024 · 9c8c207 · 9c8c207
1 parent 0e74808
commit 9c8c207
Show file tree

Hide file tree

Showing 12 changed files with 43 additions and 89 deletions.
diff --git a/docs/api_client/client.rst b/docs/api_client/client.rst
@@ -0,0 +1,9 @@
+Platform API Client
+==========================
+
+.. currentmodule:: enlyze.api_client.client
+
+.. autoclass:: _PaginatedResponse
+
+.. autoclass:: PlatformApiClient()
+    :members:
diff --git a/docs/api_clients/timeseries/index.rst → docs/api_client/index.rst b/docs/api_clients/timeseries/index.rst → docs/api_client/index.rst
diff --git a/docs/api_clients/production_runs/models.rst → docs/api_client/models.rst b/docs/api_clients/production_runs/models.rst → docs/api_client/models.rst
@@ -1,22 +1,47 @@
 Models
 ======
 
-.. currentmodule:: enlyze.api_clients.production_runs.models
+.. currentmodule:: enlyze.api_client.models
 
-.. autoclass:: ProductionRunsApiModel()
+.. autoclass:: PlatformApiModel()
 
-.. autoclass:: ProductionRun()
+.. autoclass:: Site()
+    :members:
+    :undoc-members:
+    :exclude-members: model_config, model_fields
+    :show-inheritance:
+
+.. autoclass:: MachineBase()
     :members:
     :undoc-members:
     :exclude-members: model_config, model_fields
     :show-inheritance:
 
+
 .. autoclass:: Machine()
     :members:
     :undoc-members:
     :exclude-members: model_config, model_fields
     :show-inheritance:
 
+.. autoclass:: Variable()
+    :members:
+    :undoc-members:
+    :exclude-members: model_config, model_fields
+    :show-inheritance:
+
+.. autoclass:: TimeseriesData()
+    :members:
+    :undoc-members:
+    :exclude-members: model_config, model_fields
+    :show-inheritance:
+
+.. autoclass:: ProductionRun()
+    :members:
+    :undoc-members:
+    :exclude-members: model_config, model_fields
+    :show-inheritance:
+
 .. autoclass:: Quantity()
     :members:
     :undoc-members:

diff --git a/docs/api_clients/base.rst b/docs/api_clients/base.rst
diff --git a/docs/api_clients/index.rst b/docs/api_clients/index.rst
diff --git a/docs/api_clients/production_runs/client.rst b/docs/api_clients/production_runs/client.rst
diff --git a/docs/api_clients/production_runs/index.rst b/docs/api_clients/production_runs/index.rst
diff --git a/docs/api_clients/timeseries/client.rst b/docs/api_clients/timeseries/client.rst
diff --git a/docs/api_clients/timeseries/models.rst b/docs/api_clients/timeseries/models.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -20,4 +20,4 @@ User's Guide
     models
     errors
     constants
-    api_clients/index
+    api_client/index
diff --git a/src/enlyze/api_client/client.py b/src/enlyze/api_client/client.py
@@ -111,6 +111,7 @@ def get_paginated(
         self, api_path: str, model: Type[T], **kwargs: Any
     ) -> Iterator[T]:
         """Retrieve objects from paginated ENLYZE Platform API endpoint via HTTP GET
+
         :param api_path: Relative URL path inside the ENLYZE Platform API
         :param model: Class derived from
             :class:`~enlyze.api_client.models.PlatformApiModel`

diff --git a/src/enlyze/api_client/models.py b/src/enlyze/api_client/models.py
@@ -33,6 +33,9 @@ def to_user_model(self) -> user_models.Site:
 
 
 class MachineBase(PlatformApiModel):
+    """The machine related information returned for a
+    :class:`.ProductionRun`"""
+
     name: str
     uuid: UUID
 
@@ -159,7 +162,7 @@ def to_user_model(self) -> user_models.Quantity:
 
 class ProductionRun(PlatformApiModel):
     uuid: UUID
-    machine: MachineBase = Field(alias="appliance")
+    machine: MachineBase
     average_throughput: Optional[float]
     production_order: str
     product: Product