Add some basic 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 Kamaki is a simple, yet intuitive, command-line tool for managing clouds. Run
10 it without arguments to see a list of available commands.
11
12 It is an initial implementation of the OpenStack Compute API, v1.1, with custom
13 extensions specific to the Synnefo IaaS cloud management software.
14
15 **Warning:** Kamaki is still a work in progress and can not yet authenticate
16 with *Nova*.
17
18
19 Contents:
20
21 .. toctree::
22    :maxdepth: 2
23    
24    client
25
26
27
28 Indices and tables
29 ==================
30
31 * :ref:`genindex`
32 * :ref:`modindex`
33 * :ref:`search`
34