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
22 path.append('/home/saxtouri/src/objpool')
24 from objpool import http
27 stderr.write("`objpool` package is required to build kamaki docs.\n")
30 path.append(os.path.join(os.path.abspath(os.path.dirname(__file__)), '..'))
32 # -- General configuration ---------------------------------------------------
34 # If your documentation needs a minimal Sphinx version, state it here.
37 # Add any Sphinx extension module names here, as strings. They can be
38 #extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
39 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']
41 # Add any paths that contain templates here, relative to this directory.
42 templates_path = ['_templates']
44 # The suffix of source filenames.
45 source_suffix = '.rst'
47 # The encoding of source files.
48 #source_encoding = 'utf-8-sig'
50 # The master toctree document.
53 # General information about the project.
55 copyright = u'2012, GRNET'
57 # The version info for the project you're documenting, acts as replacement for
58 # |version| and |release|, also used in various other places throughout the
61 # The short X.Y version.
63 # The full version, including alpha/beta/rc tags.
66 # The language for content autogenerated by Sphinx. Refer to documentation
67 # for a list of supported languages.
70 # There are two options for replacing |today|: either, you set today to some
71 # non-false value, then it is used:
73 # Else, today_fmt is used as the format for a strftime call.
74 #today_fmt = '%B %d, %Y'
76 # List of patterns, relative to source directory, that match files and
77 # directories to ignore when looking for source files.
78 exclude_patterns = ['_build']
80 # The reST default role (used for this markup: `text`) to use for all
84 # If true, '()' will be appended to :func: etc. cross-reference text.
85 #add_function_parentheses = True
87 # If true, the current module name will be prepended to all description
88 # unit titles (such as .. function::).
89 #add_module_names = True
91 # If true, sectionauthor and moduleauthor directives will be shown in the
92 # output. They are ignored by default.
95 # The name of the Pygments (syntax highlighting) style to use.
96 pygments_style = 'sphinx'
98 # A list of ignored prefixes for module index sorting.
99 #modindex_common_prefix = []
102 # -- Options for HTML output -------------------------------------------------
104 # The theme to use for HTML and HTML Help pages. See the documentation for
105 # a list of builtin themes.
106 html_theme = 'nature'
108 # Theme options are theme-specific and customize the look and feel of a theme
109 # further. For a list of options available for each theme, see the
111 #html_theme_options = {}
113 # Add any paths that contain custom themes here, relative to this directory.
114 #html_theme_path = []
116 # The name for this set of Sphinx documents. If None, it defaults to
117 # "<project> v<release> documentation".
120 # A shorter title for the navigation bar. Default is the same as html_title.
121 #html_short_title = None
123 # The name of an image file (relative to this directory) to place at the top
127 # The name of an image file (within the static path) to use as favicon of the
128 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
132 # Add any paths that contain custom static files (such as style sheets) here,
133 # relative to this directory. They are copied after the builtin static files,
134 # so a file named "default.css" will overwrite the builtin "default.css".
135 html_static_path = ['_static']
137 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
138 # using the given strftime format.
139 #html_last_updated_fmt = '%b %d, %Y'
141 # If true, SmartyPants will be used to convert quotes and dashes to
142 # typographically correct entities.
143 #html_use_smartypants = True
145 # Custom sidebar templates, maps document names to template names.
148 # Additional templates that should be rendered to pages, maps page names to
150 #html_additional_pages = {}
152 # If false, no module index is generated.
153 #html_domain_indices = True
155 # If false, no index is generated.
156 #html_use_index = True
158 # If true, the index is split into individual pages for each letter.
159 #html_split_index = False
161 # If true, links to the reST sources are added to the pages.
162 #html_show_sourcelink = True
164 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
165 #html_show_sphinx = True
167 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
168 #html_show_copyright = True
170 # If true, an OpenSearch description file will be output, and all pages will
171 # contain a <link> tag referring to it. The value of this option must be the
172 # base URL from which the finished HTML is served.
173 #html_use_opensearch = ''
175 # This is the file name suffix for HTML files (e.g. ".xhtml").
176 #html_file_suffix = None
178 # Output file base name for HTML help builder.
179 htmlhelp_basename = 'Kamakidoc'
182 # -- Options for LaTeX output ------------------------------------------------
185 # The paper size ('letterpaper' or 'a4paper').
186 #'papersize': 'letterpaper',
188 # The font size ('10pt', '11pt' or '12pt').
189 #'pointsize': '10pt',
191 # Additional stuff for the LaTeX preamble.
195 # Grouping the document tree into LaTeX files. List of tuples
196 # (source start file, target name, title, author, documentclass
199 ('index', 'Kamaki.tex', u'Kamaki Documentation',
203 # The name of an image file (relative to this directory) to place at the top of
207 # For "manual" documents, if this is true, then toplevel headings are parts,
209 #latex_use_parts = False
211 # If true, show page references after internal links.
212 #latex_show_pagerefs = False
214 # If true, show URL addresses after external links.
215 #latex_show_urls = False
217 # Documents to append as an appendix to all manuals.
218 #latex_appendices = []
220 # If false, no module index is generated.
221 #latex_domain_indices = True
224 # -- Options for manual page output ------------------------------------------
226 # One entry per manual page. List of tuples
227 # (source start file, name, description, authors, manual section).
229 ('man/kamaki', 'kamaki', 'Command-line tool for managing clouds', '', 1),
232 # If true, show URL addresses after external links.
233 #man_show_urls = False
236 # -- Options for Texinfo output ----------------------------------------------
238 # Grouping the document tree into Texinfo files. List of tuples
239 # (source start file, target name, title, author,
240 # dir menu entry, description, category)
241 texinfo_documents = [
242 ('index', 'Kamaki', u'Kamaki Documentation',
243 u'GRNET', 'Kamaki', 'One line description of project.',
247 # Documents to append as an appendix to all manuals.
248 #texinfo_appendices = []
250 # If false, no module index is generated.
251 #texinfo_domain_indices = True
253 # How to display URL addresses: 'footnote', 'no', or 'inline'.
254 #texinfo_show_urls = 'footnote'