F yaml documentation

A draft of a small documentation of the yaml interface in caosdb-advanced-user-tools.

src/doc/yaml_interface.rst

@@ -69,13 +69,13 @@ List attributes are a bit special:
 
 .. code-block:: yaml
 
-  datatype: LIST(DOUBLE)
+  datatype: LIST<DOUBLE>
 
 would declare a list datatype of DOUBLE elements.
 
 .. code-block:: yaml
 
-  datatype: LIST(Project)
+  datatype: LIST<Project>
 
 would declare a list of elements with datatype Project.
 
@@ -84,8 +84,8 @@ Keywords
 --------
 
 - **parent**: Parent of this entity.
-- **importance**: Importance of this entity.
-- **datatype**: The datatpye of this property, e.g. TEXT, INTEGER or Project.
+- **importance**: Importance of this entity. Possible values: "recommended", "obligatory", "suggested"
+- **datatype**: The datatype of this property, e.g. TEXT, INTEGER or Project.
 - **unit**: The unit of the property, e.g. "m/s".
 - **description**: A description for this entity.
 - **recommended_properties**: Add properties to this entity with importance "recommended".
@@ -94,3 +94,24 @@ Keywords
 - **inherit_from_recommended**: Inherit from another entity using the specified importance level including the higher importance level "obligatory". This would add a corresponding parent and add all obligatory and recommended properties from the parent.
 - **inherit_from_suggested including higher importance levels**: Inherit from another entity using the specified importance level. This would add a corresponding parent and add all obligatory, recommended and suggested properties from the parent.
 - **inherit_from_obligatory**: Inherit from another entity using the specified importance level. This would add a corresponding parent and add all obligatory properties from the parent.
+
+Usage
+-----
+
+You can use the yaml parser directly in python as follows:
+
+
+.. code-block:: python
+   
+  from caosadvancedtools.models import parser as parser
+  model = parser.parse_model_from_yaml("model.yml")
+
+
+This creates a DataModel object containing all entities defined in the yaml file.
+
+You can then use the functions from caosadvancedtools.models.data_model.DataModel to synchronize
+the model with a CaosDB instance, e.g.:
+
+.. code-block:: python
+   
+  model.sync_data_model()