Documentation fixes

ankaios_sdk/_components/manifest.py

@@ -39,6 +39,14 @@
     .. code-block:: python
 
         manifest = Manifest.from_dict({"apiVersion": "1.0", "workloads": {}})
+
+- Check if the manifest is valid:
+    .. code-block:: python
+
+        try:
+            manifest = Manifest.from_file("path/to/manifest.yaml")
+        except InvalidManifestException as e:
+            print(f"Invalid manifest: {e}")
 """
 
 import yaml

ankaios_sdk/_components/workload.py

@@ -30,16 +30,16 @@
 - Create a workload using the WorkloadBuilder:
     .. code-block:: python
 
-        workload = Workload.builder()
-            .workload_name("nginx")
-            .agent_name("agent_A")
-            .runtime("podman")
-            .restart_policy("NEVER")
+        workload = Workload.builder() \\
+            .workload_name("nginx") \\
+            .agent_name("agent_A") \\
+            .runtime("podman") \\
+            .restart_policy("NEVER") \\
             .runtime_config("image: docker.io/library/nginx\\n"
-                            + "commandOptions: [\"-p\", \"8080:80\"]")
-            .add_dependency("other_workload", "ADD_COND_RUNNING")
-            .add_tag("key1", "value1")
-            .add_tag("key2", "value2")
+                            + "commandOptions: [\\"-p\\", \\"8080:80\\"]") \\
+            .add_dependency("other_workload", "ADD_COND_RUNNING") \\
+            .add_tag("key1", "value1") \\
+            .add_tag("key2", "value2") \\
             .build()
 
 - Update fields of the workload:

ankaios_sdk/_components/workload_state.py

@@ -223,7 +223,7 @@ class WorkloadExecutionState:
     Attributes:
         state (WorkloadStateEnum): The state of the workload.
         substate (WorkloadSubStateEnum): The sub-state of the workload.
-        info (str): Additional information about the workload state.
+        additional_info (str): Additional information about the workload state.
     """
     def __init__(self, state: _ank_base.ExecutionState) -> None:
         """

ankaios_sdk/ankaios.py

@@ -101,11 +101,14 @@
 - Wait for a workload to reach a state:
     .. code-block:: python
 
-        ret = ankaios.wait_for_workload_to_reach_state(
-            instance_name,
-            WorkloadStateEnum.RUNNING
-        )
-        if ret:
+        try:
+            ankaios.wait_for_workload_to_reach_state(
+                instance_name,
+                WorkloadStateEnum.RUNNING
+            )
+        except TimeoutError:
+            print(f"State not reached in time.")
+        else:
             print(f"State reached.")
 """
 

docs/source/ankaios.rst

@@ -11,11 +11,3 @@ Ankaios Class
     :members:
     :undoc-members:
     :show-inheritance:
-
-AnkaiosLogLevel Enum
----------------------
-
-.. autoclass:: ankaios_sdk.ankaios.AnkaiosLogLevel
-    :members:
-    :undoc-members:
-    :show-inheritance: