add properly DMS docs

Author: gtema

doc/source/cli/dms.rst

@@ -0,0 +1,36 @@
+=====================================================
+Distributed Message Service (DMS) command-line client
+=====================================================
+
+The DMS client is the command-line interface (CLI) for
+the Distributed Message Service (DMS) API and its extensions.
+
+For help on a specific `dms` command, enter:
+
+.. code-block:: console
+
+   $ openstack dms help SUBCOMMAND
+
+.. _dms_queue:
+
+Queue operations
+----------------
+
+.. autoprogram-cliff:: openstack.dms.v1
+   :command: dms queue *
+
+.. _dms_group:
+
+Group operations
+----------------
+
+.. autoprogram-cliff:: openstack.dms.v1
+   :command: dms group *
+
+.. _dms_quota:
+
+Quota operations
+----------------
+
+.. autoprogram-cliff:: openstack.dms.v1
+   :command: dms quota *

doc/source/cli/index.rst

@@ -7,3 +7,4 @@
    cce.rst
    load_balancer.rst
    volume_backup.rst
+   dms.rst

doc/source/user/index.rst

@@ -125,6 +125,7 @@ control which services can be used.
    Key Management Service <proxies/kms>
    Cloud Container Engine <proxies/cce>
    Volume Backup Service <proxies/volume_backup>
+   Distributed Message Service <proxies/dms>
 
 Resource Interface
 ~~~~~~~~~~~~~~~~~~

doc/source/user/proxies/dms.rst

@@ -0,0 +1,38 @@
+DMS API
+=======
+
+.. automodule:: otcextensions.sdk.dms.v1._proxy
+
+The Distributed Message Service Class
+-------------------------------------
+
+The dms high-level interface is available through the ``dms``
+member of a :class:`~openstack.connection.Connection` object.  The
+``dms`` member will only be added if the ``otcextensions.sdk.register_otc_extensions(conn)`` method is called.
+
+Queue Operations
+^^^^^^^^^^^^^^^^
+
+.. autoclass:: otcextensions.sdk.dms.v1._proxy.Proxy
+
+   .. automethod:: otcextensions.sdk.dms.v1._proxy.Proxy.queues
+   .. automethod:: otcextensions.sdk.dms.v1._proxy.Proxy.create_queue
+   .. automethod:: otcextensions.sdk.dms.v1._proxy.Proxy.get_queue
+   .. automethod:: otcextensions.sdk.dms.v1._proxy.Proxy.delete_queue
+
+
+Message Group Operations
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. autoclass:: otcextensions.sdk.dms.v1._proxy.Proxy
+
+  .. automethod:: otcextensions.sdk.dms.v1._proxy.Proxy.groups
+  .. automethod:: otcextensions.sdk.dms.v1._proxy.Proxy.create_group
+  .. automethod:: otcextensions.sdk.dms.v1._proxy.Proxy.delete_group
+
+DMS Quota Operations
+^^^^^^^^^^^^^^^^^^^^
+
+.. autoclass:: otcextensions.sdk.dms.v1._proxy.Proxy
+
+  .. automethod:: otcextensions.sdk.dms.v1._proxy.Proxy.quotas

otcextensions/sdk/dms/v1/_proxy.py

@@ -26,15 +26,14 @@ def create_queue(self, **kwargs):
 
         :param dict kwargs: Keyword arguments which will be used to overwrite a
             :class:`~otcextensions.sdk.dms.v1.queue.Queue`
-        ::rtype: :class:`~otcextensions.sdk.dms.v1.queue.Queue`
         """
         return self._create(_queue.Queue, **kwargs)
 
     def queues(self):
         """List all queues
 
-        :returns: A generator of Queue object
-        ::rtype: :class:`~otcextensions.sdk.dms.v1.queue.Queue`
+        :returns: A generator of Queue object of
+            :class:`~otcextensions.sdk.dms.v1.queue.Queue`
         """
         return self._list(_queue.Queue, paginated=False)
 
@@ -45,7 +44,6 @@ def get_queue(self, queue):
             :class:`~otcextensions.sdk.dms.v1.queue.Queue`
         :returns: one object of class
             :class:`~otcextensions.sdk.dms.v1.queue.Queue`
-        ::rtype: :class:`~otcextensions.sdk.dms.v1.queue.Queue`
         """
         return self._get(_queue.Queue, queue)
 
@@ -57,7 +55,7 @@ def delete_queue(self, queue, ignore_missing=True):
         :param bool ignore_missing: When set to ``False``
             :class:`~otcextensions.sdk.exceptions.ResourceNotFound` will be
             raised when the queue does not exist.
-        :returns: ``None``
+        :returns: `None`
         """
 
         self._delete(_queue.Queue, queue, ignore_missing=ignore_missing)
@@ -89,7 +87,7 @@ def groups(self, queue, include_deadletter=False):
         :param queue: The queue id or an instance of
             :class:`~otcextensions.sdk.dms.v1.queue.Queue`
         :returns: A generator of Group object
-        ::rtype: :class:`~otcextensions.sdk.dms.v1.queue.Group`
+        :rtype: :class:`~otcextensions.sdk.dms.v1.queue.Group`
         """
         queue_id = queue
         if isinstance(queue, _queue.Queue):
@@ -170,6 +168,6 @@ def quotas(self):
         """List quota
 
         :returns: A generator of Quota object
-        ::rtype: :class:`~otcextensions.sdk.dms.v1.quota.Quota`
+        :rtype: :class:`~otcextensions.sdk.dms.v1.quota.Quota`
         """
         return self._list(_quota.Quota)