1 # -*- coding: utf-8 -*-
3 # Copyright 2011-2013 GRNET S.A. All rights reserved.
5 # Redistribution and use in source and binary forms, with or
6 # without modification, are permitted provided that the following
9 # 1. Redistributions of source code must retain the above
10 # copyright notice, this list of conditions and the following
13 # 2. Redistributions in binary form must reproduce the above
14 # copyright notice, this list of conditions and the following
15 # disclaimer in the documentation and/or other materials
16 # provided with the distribution.
18 # THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
19 # OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20 # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21 # PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
22 # CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
25 # USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
26 # AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
28 # ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 # POSSIBILITY OF SUCH DAMAGE.
31 # The views and conclusions contained in the software and
32 # documentation are those of the authors and should not be
33 # interpreted as representing official policies, either expressed
34 # or implied, of GRNET S.A.
38 # Kamaki documentation build configuration file, created by
39 # sphinx-quickstart on Tue Nov 29 15:15:50 2011.
41 # This file is execfile()d with the current directory set to its containing
44 # Note that not all possible configuration values are present in this
45 # auto-generated file.
47 # All configuration values have a default; values that are commented out
48 # serve to show the default.
50 # If extensions (or modules to document with autodoc) are in another directory,
51 # add these directories to sys.path here. If the directory is relative to the
52 # documentation root, use os.path.abspath to make it absolute, like shown here.
54 from sys import path, stderr
58 SITE_PACKAGES_PATH = os.path.expanduser(
59 '~/src/kamaki/docsenv/lib/python2.7/site-packages')
62 from objpool.http import PooledHTTPConnection
65 path.insert(0, SITE_PACKAGES_PATH)
67 from objpool.http import PooledHTTPConnection
70 stderr.write("`objpool` package is required to build kamaki docs.\n")
74 from progress.bar import ShadyBar
77 path.insert(0, SITE_PACKAGES_PATH)
79 from progress.bar import ShadyBar
82 stderr.write("`progress` package is required to build kamaki docs.\n")
85 path.insert(0, os.path.join(os.path.abspath(os.path.dirname(__file__)), '..'))
87 # -- General configuration ---------------------------------------------------
89 # If your documentation needs a minimal Sphinx version, state it here.
92 # Add any Sphinx extension module names here, as strings. They can be
93 #extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
94 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']
96 # Add any paths that contain templates here, relative to this directory.
97 templates_path = ['_templates']
99 # The suffix of source filenames.
100 source_suffix = '.rst'
102 # The encoding of source files.
103 #source_encoding = 'utf-8-sig'
105 # The master toctree document.
108 # General information about the project.
110 copyright = u'2013, GRNET'
112 # The version info for the project you're documenting, acts as replacement for
113 # |version| and |release|, also used in various other places throughout the
116 # The short X.Y version.
118 # The full version, including alpha/beta/rc tags.
121 release = kamaki.__version__
125 # The language for content autogenerated by Sphinx. Refer to documentation
126 # for a list of supported languages.
129 # There are two options for replacing |today|: either, you set today to some
130 # non-false value, then it is used:
132 # Else, today_fmt is used as the format for a strftime call.
133 #today_fmt = '%B %d, %Y'
135 # List of patterns, relative to source directory, that match files and
136 # directories to ignore when looking for source files.
137 exclude_patterns = ['_build']
139 # The reST default role (used for this markup: `text`) to use for all
143 # If true, '()' will be appended to :func: etc. cross-reference text.
144 #add_function_parentheses = True
146 # If true, the current module name will be prepended to all description
147 # unit titles (such as .. function::).
148 #add_module_names = True
150 # If true, sectionauthor and moduleauthor directives will be shown in the
151 # output. They are ignored by default.
152 #show_authors = False
154 # The name of the Pygments (syntax highlighting) style to use.
155 pygments_style = 'sphinx'
157 # A list of ignored prefixes for module index sorting.
158 #modindex_common_prefix = []
161 # -- Options for HTML output -------------------------------------------------
163 # The theme to use for HTML and HTML Help pages. See the documentation for
164 # a list of builtin themes.
165 #html_theme = 'nature'
166 html_theme = 'default'
167 html_theme_options = {
168 'collapsiblesidebar': 'true',
169 'footerbgcolor': '#55b577',
170 'footertextcolor': '#000000',
171 'sidebarbgcolor': '#ffffff',
172 'sidebarbtncolor': '#f2f2f2',
173 'sidebartextcolor': '#000000',
174 'sidebarlinkcolor': '#328e4a',
175 'relbarbgcolor': '#55b577',
176 'relbartextcolor': '#ffffff',
177 'relbarlinkcolor': '#ffffff',
178 'bgcolor': '#ffffff',
179 'textcolor': '#000000',
180 'headbgcolor': '#ffffff',
181 'headtextcolor': '#000000',
182 'headlinkcolor': '#c60f0f',
183 'linkcolor': '#328e4a',
184 'visitedlinkcolor': '#63409b',
185 'codebgcolor': '#eeffcc',
186 'codetextcolor': '#333333'
190 # Theme options are theme-specific and customize the look and feel of a theme
191 # further. For a list of options available for each theme, see the
193 #html_theme_options = {}
195 # Add any paths that contain custom themes here, relative to this directory.
196 #html_theme_path = []
198 # The name for this set of Sphinx documents. If None, it defaults to
199 # "<project> v<release> documentation".
202 # A shorter title for the navigation bar. Default is the same as html_title.
203 #html_short_title = None
205 # The name of an image file (relative to this directory) to place at the top
209 # The name of an image file (within the static path) to use as favicon of the
210 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
214 # Add any paths that contain custom static files (such as style sheets) here,
215 # relative to this directory. They are copied after the builtin static files,
216 # so a file named "default.css" will overwrite the builtin "default.css".
217 html_static_path = ['_static']
219 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
220 # using the given strftime format.
221 #html_last_updated_fmt = '%b %d, %Y'
223 # If true, SmartyPants will be used to convert quotes and dashes to
224 # typographically correct entities.
225 #html_use_smartypants = True
227 # Custom sidebar templates, maps document names to template names.
230 # Additional templates that should be rendered to pages, maps page names to
232 #html_additional_pages = {}
234 # If false, no module index is generated.
235 #html_domain_indices = True
237 # If false, no index is generated.
238 #html_use_index = True
240 # If true, the index is split into individual pages for each letter.
241 #html_split_index = False
243 # If true, links to the reST sources are added to the pages.
244 #html_show_sourcelink = True
246 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
247 #html_show_sphinx = True
249 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
250 #html_show_copyright = True
252 # If true, an OpenSearch description file will be output, and all pages will
253 # contain a <link> tag referring to it. The value of this option must be the
254 # base URL from which the finished HTML is served.
255 #html_use_opensearch = ''
257 # This is the file name suffix for HTML files (e.g. ".xhtml").
258 #html_file_suffix = None
260 # Output file base name for HTML help builder.
261 htmlhelp_basename = 'Kamakidoc'
264 # -- Options for LaTeX output ------------------------------------------------
267 # The paper size ('letterpaper' or 'a4paper').
268 #'papersize': 'letterpaper',
270 # The font size ('10pt', '11pt' or '12pt').
271 #'pointsize': '10pt',
273 # Additional stuff for the LaTeX preamble.
277 # Grouping the document tree into LaTeX files. List of tuples
278 # (source start file, target name, title, author, documentclass
281 ('index', 'Kamaki.tex', u'Kamaki Documentation',
285 # The name of an image file (relative to this directory) to place at the top of
289 # For "manual" documents, if this is true, then toplevel headings are parts,
291 #latex_use_parts = False
293 # If true, show page references after internal links.
294 #latex_show_pagerefs = False
296 # If true, show URL addresses after external links.
297 #latex_show_urls = False
299 # Documents to append as an appendix to all manuals.
300 #latex_appendices = []
302 # If false, no module index is generated.
303 #latex_domain_indices = True
306 # -- Options for manual page output ------------------------------------------
308 # One entry per manual page. List of tuples
309 # (source start file, name, description, authors, manual section).
311 ('man/kamaki', 'kamaki', 'Command-line tool for managing clouds', '', 1),
314 # If true, show URL addresses after external links.
315 #man_show_urls = False
318 # -- Options for Texinfo output ----------------------------------------------
320 # Grouping the document tree into Texinfo files. List of tuples
321 # (source start file, target name, title, author,
322 # dir menu entry, description, category)
323 texinfo_documents = [
324 ('index', 'Kamaki', u'Kamaki Documentation',
325 u'GRNET', 'Kamaki', 'One line description of project.',
329 # Documents to append as an appendix to all manuals.
330 #texinfo_appendices = []
332 # If false, no module index is generated.
333 #texinfo_domain_indices = True
335 # How to display URL addresses: 'footnote', 'no', or 'inline'.
336 #texinfo_show_urls = 'footnote'