extend production runs api docs by models

enlyze · Oct 5, 2023 · 0a8064c · 0a8064c
1 parent 6db3495
commit 0a8064c
Show file tree

Hide file tree

Showing 3 changed files with 57 additions and 0 deletions.
diff --git a/docs/api_clients/production_runs/index.rst b/docs/api_clients/production_runs/index.rst
@@ -5,3 +5,4 @@ Production Runs API
  :maxdepth: 1
 
  client
+ models
diff --git a/docs/api_clients/production_runs/models.rst b/docs/api_clients/production_runs/models.rst
@@ -0,0 +1,36 @@
+Models
+======
+
+.. currentmodule:: enlyze.api_clients.production_runs.models
+
+.. autoclass:: ProductionRunsApiModel()
+
+.. autoclass:: ProductionRun()
+ :members:
+ :undoc-members:
+ :exclude-members: model_config, model_fields
+ :show-inheritance:
+
+.. autoclass:: Appliance()
+ :members:
+ :undoc-members:
+ :exclude-members: model_config, model_fields
+ :show-inheritance:
+
+.. autoclass:: Quantity()
+ :members:
+ :undoc-members:
+ :exclude-members: model_config, model_fields
+ :show-inheritance:
+
+.. autoclass:: Product()
+ :members:
+ :undoc-members:
+ :exclude-members: model_config, model_fields
+ :show-inheritance:
+
+.. autoclass:: OEEComponent()
+ :members:
+ :undoc-members:
+ :exclude-members: model_config, model_fields
+ :show-inheritance:
diff --git a/docs/models.rst b/docs/models.rst
@@ -24,3 +24,23 @@ Data models
 .. autoclass:: ResamplingMethod()
  :members:
  :undoc-members:
+
+.. autoclass:: Quantity()
+ :members:
+ :undoc-members:
+
+.. autoclass:: OEEComponent()
+ :members:
+ :undoc-members:
+
+.. autoclass:: Product()
+ :members:
+ :undoc-members:
+
+.. autoclass:: ProductionRun()
+ :members:
+ :undoc-members:
+
+.. autoclass:: ProductionRuns()
+ :members:
+ :undoc-members: