Update documentation for history
[kamaki] / docs / conf.py
index dcc5871..85715f5 100644 (file)
@@ -1,5 +1,40 @@
 # -*- coding: utf-8 -*-
 #
+# Copyright 2011-2013 GRNET S.A. All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or
+# without modification, are permitted provided that the following
+# conditions are met:
+#
+#   1. Redistributions of source code must retain the above
+#      copyright notice, this list of conditions and the following
+#      disclaimer.
+#
+#   2. Redistributions in binary form must reproduce the above
+#      copyright notice, this list of conditions and the following
+#      disclaimer in the documentation and/or other materials
+#      provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
+# OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
+# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
+# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
+# AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+#
+# The views and conclusions contained in the software and
+# documentation are those of the authors and should not be
+# interpreted as representing official policies, either expressed
+# or implied, of GRNET S.A.
+#
+#
+#
 # Kamaki documentation build configuration file, created by
 # sphinx-quickstart on Tue Nov 29 15:15:50 2011.
 #
 from sys import path, stderr
 import os
 
-path.append('/home/saxtouri/src/objpool')
+
+SITE_PACKAGES_PATH = os.path.expanduser(
+    '~/src/kamaki/docsenv/lib/python2.7/site-packages')
+
 try:
-    from objpool import http
-    http
+    from objpool.http import PooledHTTPConnection
+    PooledHTTPConnection
 except ImportError:
-    stderr.write("`objpool` package is required to build kamaki docs.\n")
-    #exit()
+    path.insert(0, SITE_PACKAGES_PATH)
+    try:
+        from objpool.http import PooledHTTPConnection
+        PooledHTTPConnection
+    except ImportError:
+        stderr.write('`objpool` package is required to build kamaki docs.\n')
+        exit(1)
 
-path.append(os.path.join(os.path.abspath(os.path.dirname(__file__)), '..'))
+
+try:
+    from astakosclient import AstakosClient
+    AstakosClient
+except ImportError:
+    path.insert(0, '%s/%s' % (
+        SITE_PACKAGES_PATH,
+        'astakosclient-0.14.5next_10224_6c10f58-py2.7.egg'))
+    try:
+        from astakosclient import AstakosClient
+        AstakosClient
+    except ImportError:
+        stderr.write(
+            '`astakosclient` package is required to build kamaki docs.\n')
+        exit(1)
+
+# try:
+#     from progress.bar import ShadyBar
+#     ShadyBar
+# except ImportError:
+#     path.insert(0, SITE_PACKAGES_PATH)
+#     try:
+#         from progress.bar import ShadyBar
+#         ShadyBar
+#     except ImportError:
+#         stderr.write(
+#           '`progress` package is suggested to build kamaki docs.\n')
+
+path.insert(0, os.path.join(os.path.abspath(os.path.dirname(__file__)), '..'))
 
 # -- General configuration ---------------------------------------------------
 
@@ -52,16 +123,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.12'
 # 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.
@@ -103,7 +178,30 @@ pygments_style = 'sphinx'
 
 # 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