Add some documentation for cluster management
[kamaki] / docs / index.rst
1 .. Kamaki documentation master file, created by
2    sphinx-quickstart on Tue Nov 29 15:15:50 2011.
3    You can adapt this file completely to your liking, but it should at least
4    contain the root `toctree` directive.
5  
6 Kamaki project documentation
7 ============================
8
9 .. image:: /images/kamaki-logo.png
10
11 ./kamaki is a multipurpose, interactive command-line tool and also a client
12 development API for managing clouds.
13
14 As a development library, it implements the OpenStack APIs,
15 along with the custom extensions introduced by Synnefo
16 (`Synnefo IaaS <http://www.synnefo.org/>`_).
17
18 ./kamaki is open source and released under a 2-clause BSD License.
19
20
21 Contents:
22 *********
23
24 .. toctree::
25    :maxdepth: 2
26    :numbered:
27    :glob:
28    
29    overview
30    installation
31    setup
32    usage
33    commands
34    examples
35    devguide
36
37
38 Indices and tables
39 ==================
40
41 * :ref:`genindex`
42 * :ref:`modindex`
43 * :ref:`search`