Initialize new documents in docs

diff --git a/docs/commands.rst b/docs/commands.rst
index f203b9a..4abf5f7 100644 (file)
--- a/docs/commands.rst
+++ b/docs/commands.rst
@@ -8,7 +8,6 @@ cyclades_cli
 
 .. automodule:: kamaki.cli.commands.cyclades_cli
     :members:
-    :show-inheritance:
     :undoc-members:
 
 
@@ -34,7 +33,6 @@ astakos_cli
 
 .. automodule:: kamaki.cli.commands.astakos_cli
     :members:
-    :show-inheritance:
     :undoc-members:
 
 config_cli
@@ -42,7 +40,6 @@ config_cli
 
 .. automodule:: kamaki.cli.commands.config_cli
     :members:
-    :show-inheritance:
     :undoc-members:
 
 history_cli
@@ -50,5 +47,4 @@ history_cli
 
 .. automodule:: kamaki.cli.commands.history_cli
     :members:
-    :show-inheritance:
     :undoc-members:

diff --git a/docs/conf.py b/docs/conf.py
index 2f6b2ed..e86a948 100644 (file)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -17,6 +17,7 @@
 
 import sys, os
 
+sys.path.append('/home/saxtouri/src/synnefo/snf-common')
 try:
     from synnefo import lib
 except ImportError:

diff --git a/docs/installation.crt b/docs/installation.crt
deleted file mode 100644 (file)
index e50cd8d..0000000
--- a/docs/installation.crt
+++ /dev/null
@@ -1,2 +0,0 @@
-Installation
-============
\ No newline at end of file

diff --git a/docs/installation.rst b/docs/installation.rst
new file mode 100644 (file)
index 0000000..36c8aba
--- /dev/null
+++ b/docs/installation.rst
@@ -0,0 +1,22 @@
+Installation
+============
+
+This guide describes the standard installation proccess for kamaki, with the aspiration of covering as much cases as possible. Although kamaki was initially targeted to advanced Linux/Unix-like users, it should be quite straigh forward to install and have it up and running in most popular platforms.
+
+Linux and Unix-like enviroments
+-------------------------------
+
+Installing from source (git repos.)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Ubuntu and Debian packages
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Max OS
+------
+
+Windows
+-------
+
+Installing from source (git repos.)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

diff --git a/docs/usage.rst b/docs/usage.rst
index 5aee3e3..7c81854 100644 (file)
--- a/docs/usage.rst
+++ b/docs/usage.rst
@@ -1,3 +1,10 @@
 Usage
 =====
 
+Kamaki offers two command line interfaces: an one-command tool and an interactive shell. Both systems implement exactly the same command specifications. More details on the exact command specifications can be found in `Command Line Interfaces' section under 'Commands`. This guide covers the generic usage of both interfaces.
+
+One-command interface
+---------------------
+
+Interactive shell
+-----------------

diff --git a/kamaki/cli/utils.py b/kamaki/cli/utils.py
index fc63bab..072b49a 100644 (file)
--- a/kamaki/cli/utils.py
+++ b/kamaki/cli/utils.py
@@ -56,8 +56,8 @@ def remove_colors():
 
 def pretty_keys(d, delim='_', recurcive=False):
     """Transform keys of a dict from the form
-    str1_str2_..._strN to the form strN
-    where _ is the delimeter
+        str1_str2_..._strN to the form strN
+        where _ is the delimeter
     """
     new_d = {}
     for key, val in d.items():