add docs for z_serialize and z_deserialize functions (#531)

* add docs for z_serialize and z_deserialize functions

* add zenoh.ext to docs index

Author: DenisBiryukov91

docs/conf.py

@@ -26,6 +26,7 @@
 import tomllib
 
 import zenoh
+import zenoh.ext
 
 # -- Project information -----------------------------------------------------
 

docs/index.rst

@@ -74,3 +74,10 @@ module zenoh.handlers
 .. automodule:: zenoh.handlers
     :members:
     :undoc-members:
+
+module zenoh.ext
+================
+
+.. automodule:: zenoh.ext
+    :members:
+    :undoc-members:

zenoh/ext.pyi

@@ -43,5 +43,28 @@ class Float64(float):
 class ZDeserializeError(Exception):
     pass
 
-def z_serialize(obj: Any) -> ZBytes: ...
-def z_deserialize(tp: type[_T], zbytes: ZBytes) -> _T: ...
+def z_serialize(obj: Any) -> ZBytes:
+    """Serialize an object of supported type according to the `Zenoh serialization format <https://github.com/eclipse-zenoh/roadmap/blob/main/rfcs/ALL/Serialization.md>`_.
+
+    Supported types are:
+
+    * UInt8, UInt16, Uint32, UInt64, UInt128, Int8, Int16, Int32, Int64, Int128, int (handled as int32), Float32, Float64, float (handled as Float64), bool;
+
+    * Str, Bytes, ByteArray;
+
+    * List, Dict, Set, FrozenSet and Tuple of supported types.
+    """
+    pass
+
+def z_deserialize(tp: type[_T], zbytes: ZBytes) -> _T:
+    """Deserialize into an object of supported type according to the `Zenoh serialization format <https://github.com/eclipse-zenoh/roadmap/blob/main/rfcs/ALL/Serialization.md>`_.
+
+    Supported types are:
+
+    * UInt8, UInt16, Uint32, UInt64, UInt128, Int8, Int16, Int32, Int64, Int128, int (handled as int32), Float32, Float64, float (handled as Float64), bool;
+
+    * Str, Bytes, ByteArray;
+
+    * List, Dict, Set, FrozenSet and Tuple of supported types.
+    """
+    pass