Improvements in API documentation

Author: JEnoch

docs/api.rst

@@ -1,19 +1,187 @@
+# -*- coding: utf-8 -*-
+#
 # Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
 import os
 import sys
 sys.path.insert(0, os.path.abspath('../'))
 sys.setrecursionlimit(1500)
 
 # -- Project information -----------------------------------------------------
+
 project = 'zenoh-python'
 copyright = '2019, ATOLabs'
 author = 'ATOLabs'
-release = '0.3.0'
+
+# The short X.Y version
+version = ''
+# The full version, including alpha/beta/rc tags
+release = '0.4.0'
+
 
 # -- General configuration ---------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.intersphinx',
+    'rinoh.frontend.sphinx',
+    'numpydoc',
+    'sphinx_rtd_theme'
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
 master_doc = 'index'
-extensions = ['sphinx.ext.autodoc']
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
 language = 'python'
 
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = []
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = None
+
+autodoc_mock_imports = ['fog05_sdk','yaks']
+
 # -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
 html_theme = 'sphinx_rtd_theme'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'Eclipsefog05doc'
+
+
+# -- Options for LaTeX output ------------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+
+    'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+
+    'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+
+    'preamble': '',
+
+    # Latex figure (float) alignment
+
+    'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'Eclipsefog05.tex', 'Eclipse fog05 Documentation',
+     'Eclipse Foundation', 'manual'),
+]
+
+
+# -- Options for manual page output ------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'eclipsefog05', 'Eclipse fog05 Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output ----------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'Eclipsefog05', 'Eclipse fog05 Documentation',
+     author, 'Eclipsefog05', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+# -- Options for Epub output -------------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = project
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#
+# epub_identifier = ''
+
+# A unique identification for the text.
+#
+# epub_uid = ''
+
+# A list of files that should not be packed into the epub file.
+epub_exclude_files = ['search.html']
+
+
+# -- Extension configuration -------------------------------------------------
+
+# -- Options for intersphinx extension ---------------------------------------
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {'https://docs.python.org/': None}

docs/conf.py

@@ -1,10 +1,15 @@
-************
+============
 zenoh-python
-************
+============
 
-The *zenoh-python* library provides a zenoh client API for the zenoh protocol.
+The *zenoh-python* library provides a Python `zenoh client API <zenoh-api.html>`_ for zenoh.
+
+Note that this library also provides a low-level API (`zenoh-net <zenoh-net-api.html>`_)
+that gives access to the zenoh protocol primitives and allow some
+advanced use cases where a fine tuning of the protocol is required.
 
 .. toctree::
-    :maxdepth: 10
+    :maxdepth: 1
 
-    api
+    zenoh API <zenoh-api>
+    zenoh-net API <zenoh-net-api>

docs/index.rst

@@ -0,0 +1,49 @@
+===================
+Zenoh API Reference
+===================
+
+Zenoh
+-----
+.. autoclass:: zenoh.Zenoh
+    :members:
+
+Workspace
+---------
+.. autoclass:: zenoh.Workspace
+    :members:
+
+Admin
+-----
+.. autoclass:: zenoh.Admin
+    :members:
+
+Value
+-----
+.. autoclass:: zenoh.Value
+    :members: get_value, get_encoding
+
+Encoding
+--------
+.. autoclass:: zenoh.Encoding
+    :members:
+
+Change
+------
+.. autoclass:: zenoh.Change
+    :members:
+
+ChangeKind
+----------
+.. autoclass:: zenoh.ChangeKind
+    :members:
+
+Data
+----
+.. autoclass:: zenoh.Data
+    :members:
+
+Timestamp
+---------
+.. autoclass:: zenoh.core.Timestamp
+    :members:
+

docs/zenoh-api.rst

@@ -0,0 +1,28 @@
+=======================
+Zenoh-net API Reference
+=======================
+
+Session
+-------
+.. autoclass:: zenoh.net.Session
+    :members:
+
+SubscriberMode
+--------------
+.. autoclass:: zenoh.net.SubscriberMode
+    :members:
+
+DataInfo
+--------
+.. autoclass:: zenoh.net.DataInfo
+    :members:
+
+QueryDest
+---------
+.. autoclass:: zenoh.net.QueryDest
+    :members:
+
+QueryReply
+----------
+.. autoclass:: zenoh.net.QueryReply
+    :members:

docs/zenoh-net-api.rst

@@ -18,5 +18,7 @@
 from .encoding import *
 from . import exceptions
 from .selector import Selector
-from .value import Value, Change, ChangeKind
+from .value import Value
+from .change import Change, ChangeKind
+from .data import Data
 from .path import Path

zenoh/__init__.py

@@ -40,7 +40,7 @@ def add_backend(self, beid, properties, zid=None):
             zid = self.local
         path = '/@/router/{}/plugin/storages/backend/{}'.format(
             zid, beid)
-        value = Value(properties, encoding=Encoding.PROPERTY)
+        value = Value(properties, encoding=Encoding.PROPERTIES)
         return self.ws.put(path, value)
 
     def get_backends(self, zid=None):
@@ -49,6 +49,7 @@ def get_backends(self, zid=None):
 
         :param zid: the UUID of the Zenoh router. If ``None``, the local
             Zenoh router.
+        :returns: a list of (backend_id, properties) tuples.
         '''
         if(zid is None):
             zid = self.local
@@ -66,6 +67,7 @@ def get_backend(self, beid, zid=None):
         :param beid: the Id of the backend.
         :param zid: the UUID of the Zenoh router. If ``None``, the local
             Zenoh router.
+        :returns: the backend properties.
         '''
         if(zid is None):
             zid = self.local
@@ -108,7 +110,7 @@ def add_storage(self, stid, properties, beid=None, zid=None):
             beid = 'auto'
         p = '/@/router/{}/plugin/storages/backend/{}/storage/{}'.format(
             zid, beid, stid)
-        v = Value(properties, encoding=Encoding.PROPERTY)
+        v = Value(properties, encoding=Encoding.PROPERTIES)
         return self.ws.put(p, v)
 
     def get_storages(self, beid=None, zid=None):
@@ -118,6 +120,7 @@ def get_storages(self, beid=None, zid=None):
         :param beid: the Id of the backend. If ``None``, all backends.
         :param zid: the UUID of the Zenoh router. If ``None``, the local
             Zenoh router.
+        :returns: a list of (storage_id, properties) tuples.
         '''
         if(zid is None):
             zid = self.local
@@ -137,6 +140,7 @@ def get_storage(self, stid, zid=None):
         :param stid: the Id of the storage.
         :param zid: the UUID of the Zenoh router. If ``None``, the local
             Zenoh router.
+        :returns: the storage properties.
         '''
         if(zid is None):
             zid = self.local