Files
deb-python-ceilometerclient/doc/source/index.rst
ZhiQiang Fan 2ea94891ea fix client docstring
* fix broken docstring in ceilometerclient.client
* remove non-existent `release` index
* remove duplicated reference generation in ext/gen_ref.py

Change-Id: Iad8c527e61628a406d5dd84adac875190b994fac
Closes-Bug: #1440629
2015-04-06 18:34:25 +08:00

47 lines
1.3 KiB
ReStructuredText

Python bindings to the OpenStack Ceilometer API
==================================================
This is a client for OpenStack Ceilometer API. There's :doc:`a Python API
<api>` (the :mod:`ceilometerclient` module), and a :doc:`command-line script
<shell>` (installed as :program:`ceilometer`). Each implements the entire
OpenStack Ceilometer API.
.. seealso::
You may want to read the `OpenStack Ceilometer 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/ceilometer/
Contents:
.. toctree::
:maxdepth: 2
shell
api
ref/index
ref/v1/index
ref/v2/index
Contributing
============
Code is hosted at `git.openstack.org`_. Submit bugs to the Ceilometer project on
`Launchpad`_. Submit code to the openstack/python-ceilometerclient project using
`Gerrit`_.
.. _git.openstack.org: https://git.openstack.org/cgit/openstack/python-ceilometerclient
.. _Launchpad: https://launchpad.net/ceilometer
.. _Gerrit: http://docs.openstack.org/infra/manual/developers.html#development-workflow
Run tests with ``python setup.py test``.
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`