Files
d80704a474ee838f178938898f6915dcee92bf67
python-aodhclient /doc /source /index.rst

47 lines
1.1 KiB
ReStructuredText
Raw Normal View History

2015年12月15日 11:41:51 -05:00
.. aodhclient documentation master file, created by
2015年08月28日 11:43:50 +02:00
sphinx-quickstart on Tue Jul 9 22:26:36 2013.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
2015年12月15日 11:41:51 -05:00
Python bindings to the Aodh API
===============================
2015年08月28日 11:43:50 +02:00
2015年12月15日 11:41:51 -05:00
This is a client for Aodh API. There's :doc:`a Python API
<api>` (the :mod:`aodhclient` module), and a :doc:`command-line script
<shell>` (installed as :program:`aodh`). Each implements the entire
Aodh API.
2015年08月30日 19:31:02 +02:00
.. warning::
This is a new client to interact with Aodh API. There may be differences
in functionality, syntax, and command line output when compared with the
alarm functionality provided by ceilometerclient.
2015年08月30日 19:31:02 +02:00
.. seealso::
2015年12月15日 11:41:51 -05:00
You may want to read the `Aodh Developer Guide`__ -- the overview, at
2015年08月30日 19:31:02 +02:00
least -- to get an idea of the concepts. By understanding the concepts
this library should make more sense.
__ https://docs.openstack.org/aodh/latest/
2015年08月30日 19:31:02 +02:00
2015年08月28日 11:43:50 +02:00
Contents:
.. toctree::
:maxdepth: 2
installation
2015年08月30日 19:31:02 +02:00
shell
api
2015年08月28日 11:43:50 +02:00
contributing
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`