# -*- 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.
#
-# 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.
-import sys, os
-
# If extensions (or modules to document with autodoc) are in another directory,
# 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.
-sys.path.insert(0, os.path.abspath('..'))
-# -- General configuration -----------------------------------------------------
+from sys import path, stderr
+import os
+
+try:
+ from objpool.http import PooledHTTPConnection
+ PooledHTTPConnection
+except ImportError:
+ stderr.write("`objpool` package is required to build kamaki docs.\n")
+
+try:
+ from progress.bar import ShadyBar
+ ShadyBar
+except ImportError:
+ stderr.write("`progress` package is required to build kamaki docs.\n")
+
+path.insert(0, os.path.join(os.path.abspath(os.path.dirname(__file__)), '..'))
+
+# -- 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.
# General information about the project.
project = u'Kamaki'
-copyright = u'2011, 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.2'
+version = '0.10'
# The full version, including alpha/beta/rc tags.
-release = '0.2'
+
+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.
# 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.
#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
htmlhelp_basename = 'Kamakidoc'
-# -- Options for LaTeX output --------------------------------------------------
+# -- Options for LaTeX output ------------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
}
# 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
#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).
man_pages = [
- ('index', 'kamaki', u'Kamaki Documentation',
- [u'GRNet'], 1)
+ ('man/kamaki', 'kamaki', 'Command-line tool for managing clouds', '', 1),
]
# If true, show URL addresses after external links.
#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'),
]