File: index.rst

package info (click to toggle)
python-aodhclient 3.9.1-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 596 kB
  • sloc: python: 2,812; sh: 34; makefile: 24
file content (40 lines) | stat: -rw-r--r-- 939 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
.. 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.

    __ https://docs.openstack.org/aodh/latest/


Contents
--------

.. toctree::
   :maxdepth: 2

   installation
   shell
   api
   contributing

Indices and tables
------------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`