Merge "Add telemetry resource docs"

This commit is contained in:
Jenkins
2015-05-27 18:17:04 +00:00
committed by Gerrit Code Review
9 changed files with 98 additions and 0 deletions

View File

@@ -100,6 +100,7 @@ The following services have exposed *Resource* classes.
Network <resources/network/index>
Orchestration <resources/orchestration/index>
Object Store <resources/object_store/index>
Telemetry <resources/telemetry/index>
Volume <resources/volume/index>
Low-Level Classes

View File

@@ -0,0 +1,13 @@
Telemetry Resources
===================
.. toctree::
:maxdepth: 1
v2/alarm
v2/alarm_change
v2/capability
v2/meter
v2/resource
v2/sample
v2/statistics

View File

@@ -0,0 +1,12 @@
openstack.telemetry.v2.alarm
============================
.. automodule:: openstack.telemetry.v2.alarm
The Alarm Class
---------------
The ``Alarm`` class inherits from :class:`~openstack.resource.Resource`.
.. autoclass:: openstack.telemetry.v2.alarm.Alarm
:members:

View File

@@ -0,0 +1,12 @@
openstack.telemetry.v2.alarm_change
===================================
.. automodule:: openstack.telemetry.v2.alarm_change
The AlarmChange Class
---------------------
The ``AlarmChange`` class inherits from :class:`~openstack.resource.Resource`.
.. autoclass:: openstack.telemetry.v2.alarm_change.AlarmChange
:members:

View File

@@ -0,0 +1,12 @@
openstack.telemetry.v2.capability
=================================
.. automodule:: openstack.telemetry.v2.capability
The Capability Class
--------------------
The ``Capability`` class inherits from :class:`~openstack.resource.Resource`.
.. autoclass:: openstack.telemetry.v2.capability.Capability
:members:

View File

@@ -0,0 +1,12 @@
openstack.telemetry.v2.meter
============================
.. automodule:: openstack.telemetry.v2.meter
The Meter Class
----------------
The ``Meter`` class inherits from :class:`~openstack.resource.Resource`.
.. autoclass:: openstack.telemetry.v2.meter.Meter
:members:

View File

@@ -0,0 +1,12 @@
openstack.telemetry.v2.resource
===============================
.. automodule:: openstack.telemetry.v2.resource
The Resource Class
------------------
The ``Resource`` class inherits from :class:`~openstack.resource.Resource`.
.. autoclass:: openstack.telemetry.v2.resource.Resource
:members:

View File

@@ -0,0 +1,12 @@
openstack.telemetry.v2.sample
=============================
.. automodule:: openstack.telemetry.v2.sample
The Sample Class
----------------
The ``Sample`` class inherits from :class:`~openstack.resource.Resource`.
.. autoclass:: openstack.telemetry.v2.sample.Sample
:members:

View File

@@ -0,0 +1,12 @@
openstack.telemetry.v2.statistics
=================================
.. automodule:: openstack.telemetry.v2.statistics
The Statistics Class
--------------------
The ``Statistics`` class inherits from :class:`~openstack.resource.Resource`.
.. autoclass:: openstack.telemetry.v2.statistics.Statistics
:members: