Update documentation
[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 simple, yet intuitive, command-line tool for managing clouds. Run
12 it without arguments to see a list of available commands.
13
14 It is an initial implementation of the OpenStack Compute API, v1.1, with custom
15 extensions specific to the Synnefo IaaS cloud management software.
16
17 ./kamaki is open source and released under a 2-clause BSD Licence.
18
19
20 Contents:
21
22 .. toctree::
23    :maxdepth: 3
24    
25    overview
26    clients
27    cli
28
29
30
31 Indices and tables
32 ==================
33
34 * :ref:`genindex`
35 * :ref:`modindex`
36 * :ref:`search`
37