c96b2c335d
For compliance with the Project Testing Interface as described in: https://governance.openstack.org/tc/reference/project-testing-interface.html http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html Remove [build_sphinx] as described in: http://lists.openstack.org/pipermail/openstack-dev/2018-March/128594.html Change-Id: Ib1059403dccf7a58e8a8554c1298a601c2c067a2
48 lines
1.1 KiB
ReStructuredText
48 lines
1.1 KiB
ReStructuredText
.. aodhclient documentation master file, created by
|
|
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.
|
|
|
|
Python bindings to the Aodh API
|
|
===============================
|
|
|
|
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.
|
|
|
|
.. 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.
|
|
|
|
|
|
.. seealso::
|
|
|
|
You may want to read the `Aodh Developer Guide`__ -- the overview, at
|
|
least -- to get an idea of the concepts. By understanding the concepts
|
|
this library should make more sense.
|
|
|
|
__ https://docs.openstack.org/aodh/latest/
|
|
|
|
|
|
Contents
|
|
--------
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
installation
|
|
shell
|
|
api
|
|
contributing
|
|
|
|
Indices and tables
|
|
------------------
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|
|
* :ref:`search`
|
|
|