openstack/deb-python-openstacksdk
Code Issues Proposed changes

Implement metric docs

Browse Source 
This change introduces metric docs. There is only one method in the
proxy as of right now, so that was easy.

Change-Id: Ica327f27b26e5dd4b6744566eb09ea81a6e9583e
This commit is contained in:
Brian Curtin 2017-02-16 15:58:21 -05:00
parent 5ca2fa80ad
commit 6e7840842a
2 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/source/users/index.rst
View File

@ -80,6 +80,7 @@ but listed below are the ones provided by this SDK by default.
Image v2 <proxies/image_v2>
Key Manager <proxies/key_manager>
Network <proxies/network>
Metric <proxies/metric>
Object Store <proxies/object_store>
Orchestration <proxies/orchestration>
Telemetry <proxies/telemetry>

18
doc/source/users/proxies/metric.rst Normal file
View File

@ -0,0 +1,18 @@
Metric API
==========
.. automodule:: openstack.metric.v1._proxy
The Metric Class
----------------
The metric high-level interface is available through the ``metric``
member of a :class:`~openstack.connection.Connection` object. The
``metric`` member will only be added if the service is detected.
Capability Operations
^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.metric.v1._proxy.Proxy
.. automethod:: openstack.metric.v1._proxy.Proxy.capabilities