40 lines
989 B
ReStructuredText
40 lines
989 B
ReStructuredText
.. python-gnocchiclient 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 Gnocchi API
|
|
========================================================
|
|
|
|
This is a client for gnocchi API. There's :doc:`a Python API
|
|
<api>` (the :mod:`gnocchiclient` module), and a :doc:`command-line script
|
|
<shell>` (installed as :program:`gnocchi`). Each implements the entire
|
|
Gnocchi API.
|
|
|
|
.. seealso::
|
|
|
|
You may want to read the `Gnocchi 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/gnocchi/
|
|
|
|
|
|
Contents:
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
installation
|
|
shell
|
|
api
|
|
contributing
|
|
|
|
Indices and tables
|
|
==================
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|
|
* :ref:`search`
|
|
|