2015-12-15 11:41:51 -05:00

40 lines
933 B
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.
.. 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.
__ http://docs.openstack.org/developer/aodh/
Contents:
.. toctree::
:maxdepth: 2
installation
shell
api
contributing
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`