Add examples for virtual machine handling
[kamaki] / docs / conf.py
index e86a948..8aa6b79 100644 (file)
@@ -3,10 +3,11 @@
 # Kamaki documentation build configuration file, created by
 # sphinx-quickstart on Tue Nov 29 15:15:50 2011.
 #
-# This file is execfile()d with the current directory set to its containing dir.
+# This file is execfile()d with the current directory set to its containing
+# dir.
 #
 # Note that not all possible configuration values are present in this
-# autogenerated file.
+# auto-generated file.
 #
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 
-import sys, os
+from sys import path, stderr
+import os
 
-sys.path.append('/home/saxtouri/src/synnefo/snf-common')
 try:
-    from synnefo import lib
+    from objpool.http import PooledHTTPConnection
+    PooledHTTPConnection
 except ImportError:
-    sys.stderr.write("`snf-common` package is required to build kamaki docs.\n")
-    exit()
+    stderr.write("`objpool` package is required to build kamaki docs.\n")
+    # raise
 
-sys.path.append(os.path.join(os.path.abspath(os.path.dirname(__file__)),'..'))
+path.insert(0, os.path.join(os.path.abspath(os.path.dirname(__file__)), '..'))
 
-# -- General configuration -----------------------------------------------------
+# -- General configuration ---------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
 #needs_sphinx = '1.0'
 
-# Add any Sphinx extension module names here, as strings. They can be extensions
-# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+# Add any Sphinx extension module names here, as strings. They can be
+#extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']
 
 # Add any paths that contain templates here, relative to this directory.
@@ -49,16 +51,20 @@ master_doc = 'index'
 
 # General information about the project.
 project = u'Kamaki'
-copyright = u'2012, GRNet'
+copyright = u'2013, GRNET'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = '0.6'
+version = '0.8'
 # The full version, including alpha/beta/rc tags.
-release = '0.6.1'
+try:
+    import kamaki
+    release = kamaki.__version__
+except ImportError:
+    release = version
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -74,7 +80,8 @@ release = '0.6.1'
 # directories to ignore when looking for source files.
 exclude_patterns = ['_build']
 
-# The reST default role (used for this markup: `text`) to use for all documents.
+# The reST default role (used for this markup: `text`) to use for all
+# documents.
 #default_role = None
 
 # If true, '()' will be appended to :func: etc. cross-reference text.
@@ -95,11 +102,34 @@ pygments_style = 'sphinx'
 #modindex_common_prefix = []
 
 
-# -- Options for HTML output ---------------------------------------------------
+# -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'nature'
+#html_theme = 'nature'
+html_theme = 'default'
+html_theme_options = {
+    'collapsiblesidebar': 'true',
+    'footerbgcolor':    '#55b577',
+    'footertextcolor':  '#000000',
+    'sidebarbgcolor':   '#ffffff',
+    'sidebarbtncolor':  '#f2f2f2',
+    'sidebartextcolor': '#000000',
+    'sidebarlinkcolor': '#328e4a',
+    'relbarbgcolor':    '#55b577',
+    'relbartextcolor':  '#ffffff',
+    'relbarlinkcolor':  '#ffffff',
+    'bgcolor':          '#ffffff',
+    'textcolor':        '#000000',
+    'headbgcolor':      '#ffffff',
+    'headtextcolor':    '#000000',
+    'headlinkcolor':    '#c60f0f',
+    'linkcolor':        '#328e4a',
+    'visitedlinkcolor': '#63409b',
+    'codebgcolor':      '#eeffcc',
+    'codetextcolor':    '#333333'
+}
+
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
@@ -175,7 +205,7 @@ html_static_path = ['_static']
 htmlhelp_basename = 'Kamakidoc'
 
 
-# -- Options for LaTeX output --------------------------------------------------
+# -- Options for LaTeX output ------------------------------------------------
 
 latex_elements = {
 # The paper size ('letterpaper' or 'a4paper').
@@ -189,10 +219,11 @@ latex_elements = {
 }
 
 # Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title, author, documentclass [howto/manual]).
+# (source start file, target name, title, author, documentclass
+# [howto/manual]).
 latex_documents = [
   ('index', 'Kamaki.tex', u'Kamaki Documentation',
-   u'GRNet', 'manual'),
+   u'GRNET', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -216,7 +247,7 @@ latex_documents = [
 #latex_domain_indices = True
 
 
-# -- Options for manual page output --------------------------------------------
+# -- Options for manual page output ------------------------------------------
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
@@ -228,14 +259,14 @@ man_pages = [
 #man_show_urls = False
 
 
-# -- Options for Texinfo output ------------------------------------------------
+# -- Options for Texinfo output ----------------------------------------------
 
 # Grouping the document tree into Texinfo files. List of tuples
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
   ('index', 'Kamaki', u'Kamaki Documentation',
-   u'GRNet', 'Kamaki', 'One line description of project.',
+   u'GRNET', 'Kamaki', 'One line description of project.',
    'Miscellaneous'),
 ]