1 # -*- coding: utf-8 -*-
3 # Kamaki documentation build configuration file, created by
4 # sphinx-quickstart on Tue Nov 29 15:15:50 2011.
6 # This file is execfile()d with the current directory set to its containing
9 # Note that not all possible configuration values are present in this
10 # auto-generated file.
12 # All configuration values have a default; values that are commented out
13 # serve to show the default.
15 # If extensions (or modules to document with autodoc) are in another directory,
16 # add these directories to sys.path here. If the directory is relative to the
17 # documentation root, use os.path.abspath to make it absolute, like shown here.
19 from sys import path, stderr
23 from objpool.http import PooledHTTPConnection
26 stderr.write("`objpool` package is required to build kamaki docs.\n")
29 path.insert(0, os.path.join(os.path.abspath(os.path.dirname(__file__)), '..'))
31 # -- General configuration ---------------------------------------------------
33 # If your documentation needs a minimal Sphinx version, state it here.
36 # Add any Sphinx extension module names here, as strings. They can be
37 #extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
38 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']
40 # Add any paths that contain templates here, relative to this directory.
41 templates_path = ['_templates']
43 # The suffix of source filenames.
44 source_suffix = '.rst'
46 # The encoding of source files.
47 #source_encoding = 'utf-8-sig'
49 # The master toctree document.
52 # General information about the project.
54 copyright = u'2013, GRNET'
56 # The version info for the project you're documenting, acts as replacement for
57 # |version| and |release|, also used in various other places throughout the
60 # The short X.Y version.
62 # The full version, including alpha/beta/rc tags.
65 release = kamaki.__version__
69 # The language for content autogenerated by Sphinx. Refer to documentation
70 # for a list of supported languages.
73 # There are two options for replacing |today|: either, you set today to some
74 # non-false value, then it is used:
76 # Else, today_fmt is used as the format for a strftime call.
77 #today_fmt = '%B %d, %Y'
79 # List of patterns, relative to source directory, that match files and
80 # directories to ignore when looking for source files.
81 exclude_patterns = ['_build']
83 # The reST default role (used for this markup: `text`) to use for all
87 # If true, '()' will be appended to :func: etc. cross-reference text.
88 #add_function_parentheses = True
90 # If true, the current module name will be prepended to all description
91 # unit titles (such as .. function::).
92 #add_module_names = True
94 # If true, sectionauthor and moduleauthor directives will be shown in the
95 # output. They are ignored by default.
98 # The name of the Pygments (syntax highlighting) style to use.
99 pygments_style = 'sphinx'
101 # A list of ignored prefixes for module index sorting.
102 #modindex_common_prefix = []
105 # -- Options for HTML output -------------------------------------------------
107 # The theme to use for HTML and HTML Help pages. See the documentation for
108 # a list of builtin themes.
109 #html_theme = 'nature'
110 html_theme = 'default'
111 html_theme_options = {
112 'collapsiblesidebar': 'true',
113 'footerbgcolor': '#55b577',
114 'footertextcolor': '#000000',
115 'sidebarbgcolor': '#ffffff',
116 'sidebarbtncolor': '#f2f2f2',
117 'sidebartextcolor': '#000000',
118 'sidebarlinkcolor': '#328e4a',
119 'relbarbgcolor': '#55b577',
120 'relbartextcolor': '#ffffff',
121 'relbarlinkcolor': '#ffffff',
122 'bgcolor': '#ffffff',
123 'textcolor': '#000000',
124 'headbgcolor': '#ffffff',
125 'headtextcolor': '#000000',
126 'headlinkcolor': '#c60f0f',
127 'linkcolor': '#328e4a',
128 'visitedlinkcolor': '#63409b',
129 'codebgcolor': '#eeffcc',
130 'codetextcolor': '#333333'
134 # Theme options are theme-specific and customize the look and feel of a theme
135 # further. For a list of options available for each theme, see the
137 #html_theme_options = {}
139 # Add any paths that contain custom themes here, relative to this directory.
140 #html_theme_path = []
142 # The name for this set of Sphinx documents. If None, it defaults to
143 # "<project> v<release> documentation".
146 # A shorter title for the navigation bar. Default is the same as html_title.
147 #html_short_title = None
149 # The name of an image file (relative to this directory) to place at the top
153 # The name of an image file (within the static path) to use as favicon of the
154 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
158 # Add any paths that contain custom static files (such as style sheets) here,
159 # relative to this directory. They are copied after the builtin static files,
160 # so a file named "default.css" will overwrite the builtin "default.css".
161 html_static_path = ['_static']
163 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
164 # using the given strftime format.
165 #html_last_updated_fmt = '%b %d, %Y'
167 # If true, SmartyPants will be used to convert quotes and dashes to
168 # typographically correct entities.
169 #html_use_smartypants = True
171 # Custom sidebar templates, maps document names to template names.
174 # Additional templates that should be rendered to pages, maps page names to
176 #html_additional_pages = {}
178 # If false, no module index is generated.
179 #html_domain_indices = True
181 # If false, no index is generated.
182 #html_use_index = True
184 # If true, the index is split into individual pages for each letter.
185 #html_split_index = False
187 # If true, links to the reST sources are added to the pages.
188 #html_show_sourcelink = True
190 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
191 #html_show_sphinx = True
193 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
194 #html_show_copyright = True
196 # If true, an OpenSearch description file will be output, and all pages will
197 # contain a <link> tag referring to it. The value of this option must be the
198 # base URL from which the finished HTML is served.
199 #html_use_opensearch = ''
201 # This is the file name suffix for HTML files (e.g. ".xhtml").
202 #html_file_suffix = None
204 # Output file base name for HTML help builder.
205 htmlhelp_basename = 'Kamakidoc'
208 # -- Options for LaTeX output ------------------------------------------------
211 # The paper size ('letterpaper' or 'a4paper').
212 #'papersize': 'letterpaper',
214 # The font size ('10pt', '11pt' or '12pt').
215 #'pointsize': '10pt',
217 # Additional stuff for the LaTeX preamble.
221 # Grouping the document tree into LaTeX files. List of tuples
222 # (source start file, target name, title, author, documentclass
225 ('index', 'Kamaki.tex', u'Kamaki Documentation',
229 # The name of an image file (relative to this directory) to place at the top of
233 # For "manual" documents, if this is true, then toplevel headings are parts,
235 #latex_use_parts = False
237 # If true, show page references after internal links.
238 #latex_show_pagerefs = False
240 # If true, show URL addresses after external links.
241 #latex_show_urls = False
243 # Documents to append as an appendix to all manuals.
244 #latex_appendices = []
246 # If false, no module index is generated.
247 #latex_domain_indices = True
250 # -- Options for manual page output ------------------------------------------
252 # One entry per manual page. List of tuples
253 # (source start file, name, description, authors, manual section).
255 ('man/kamaki', 'kamaki', 'Command-line tool for managing clouds', '', 1),
258 # If true, show URL addresses after external links.
259 #man_show_urls = False
262 # -- Options for Texinfo output ----------------------------------------------
264 # Grouping the document tree into Texinfo files. List of tuples
265 # (source start file, target name, title, author,
266 # dir menu entry, description, category)
267 texinfo_documents = [
268 ('index', 'Kamaki', u'Kamaki Documentation',
269 u'GRNET', 'Kamaki', 'One line description of project.',
273 # Documents to append as an appendix to all manuals.
274 #texinfo_appendices = []
276 # If false, no module index is generated.
277 #texinfo_domain_indices = True
279 # How to display URL addresses: 'footnote', 'no', or 'inline'.
280 #texinfo_show_urls = 'footnote'