Statistics
| Branch: | Tag: | Revision:

root / docs / conf.py @ a41d7a1d

History | View | Annotate | Download (10.1 kB)

1
# -*- coding: utf-8 -*-
2
#
3
# Copyright 2011-2013 GRNET S.A. All rights reserved.
4
#
5
# Redistribution and use in source and binary forms, with or
6
# without modification, are permitted provided that the following
7
# conditions are met:
8
#
9
#   1. Redistributions of source code must retain the above
10
#      copyright notice, this list of conditions and the following
11
#      disclaimer.
12
#
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.
17
#
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.
30
#
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.
35
#
36
#
37
#
38
# Kamaki documentation build configuration file, created by
39
# sphinx-quickstart on Tue Nov 29 15:15:50 2011.
40
#
41
# This file is execfile()d with the current directory set to its containing
42
# dir.
43
#
44
# Note that not all possible configuration values are present in this
45
# auto-generated file.
46
#
47
# All configuration values have a default; values that are commented out
48
# serve to show the default.
49

    
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.
53

    
54
from sys import path, stderr
55
import os
56

    
57
try:
58
    from objpool.http import PooledHTTPConnection
59
    PooledHTTPConnection
60
except ImportError:
61
    stderr.write("`objpool` package is required to build kamaki docs.\n")
62
    # raise
63

    
64
path.insert(0, os.path.join(os.path.abspath(os.path.dirname(__file__)), '..'))
65

    
66
# -- General configuration ---------------------------------------------------
67

    
68
# If your documentation needs a minimal Sphinx version, state it here.
69
#needs_sphinx = '1.0'
70

    
71
# Add any Sphinx extension module names here, as strings. They can be
72
#extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
73
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']
74

    
75
# Add any paths that contain templates here, relative to this directory.
76
templates_path = ['_templates']
77

    
78
# The suffix of source filenames.
79
source_suffix = '.rst'
80

    
81
# The encoding of source files.
82
#source_encoding = 'utf-8-sig'
83

    
84
# The master toctree document.
85
master_doc = 'index'
86

    
87
# General information about the project.
88
project = u'Kamaki'
89
copyright = u'2013, GRNET'
90

    
91
# The version info for the project you're documenting, acts as replacement for
92
# |version| and |release|, also used in various other places throughout the
93
# built documents.
94
#
95
# The short X.Y version.
96
version = '0.10'
97
# The full version, including alpha/beta/rc tags.
98
try:
99
    import kamaki
100
    release = kamaki.__version__
101
except ImportError:
102
    release = version
103

    
104
# The language for content autogenerated by Sphinx. Refer to documentation
105
# for a list of supported languages.
106
#language = None
107

    
108
# There are two options for replacing |today|: either, you set today to some
109
# non-false value, then it is used:
110
#today = ''
111
# Else, today_fmt is used as the format for a strftime call.
112
#today_fmt = '%B %d, %Y'
113

    
114
# List of patterns, relative to source directory, that match files and
115
# directories to ignore when looking for source files.
116
exclude_patterns = ['_build']
117

    
118
# The reST default role (used for this markup: `text`) to use for all
119
# documents.
120
#default_role = None
121

    
122
# If true, '()' will be appended to :func: etc. cross-reference text.
123
#add_function_parentheses = True
124

    
125
# If true, the current module name will be prepended to all description
126
# unit titles (such as .. function::).
127
#add_module_names = True
128

    
129
# If true, sectionauthor and moduleauthor directives will be shown in the
130
# output. They are ignored by default.
131
#show_authors = False
132

    
133
# The name of the Pygments (syntax highlighting) style to use.
134
pygments_style = 'sphinx'
135

    
136
# A list of ignored prefixes for module index sorting.
137
#modindex_common_prefix = []
138

    
139

    
140
# -- Options for HTML output -------------------------------------------------
141

    
142
# The theme to use for HTML and HTML Help pages.  See the documentation for
143
# a list of builtin themes.
144
#html_theme = 'nature'
145
html_theme = 'default'
146
html_theme_options = {
147
    'collapsiblesidebar': 'true',
148
    'footerbgcolor':    '#55b577',
149
    'footertextcolor':  '#000000',
150
    'sidebarbgcolor':   '#ffffff',
151
    'sidebarbtncolor':  '#f2f2f2',
152
    'sidebartextcolor': '#000000',
153
    'sidebarlinkcolor': '#328e4a',
154
    'relbarbgcolor':    '#55b577',
155
    'relbartextcolor':  '#ffffff',
156
    'relbarlinkcolor':  '#ffffff',
157
    'bgcolor':          '#ffffff',
158
    'textcolor':        '#000000',
159
    'headbgcolor':      '#ffffff',
160
    'headtextcolor':    '#000000',
161
    'headlinkcolor':    '#c60f0f',
162
    'linkcolor':        '#328e4a',
163
    'visitedlinkcolor': '#63409b',
164
    'codebgcolor':      '#eeffcc',
165
    'codetextcolor':    '#333333'
166
}
167

    
168

    
169
# Theme options are theme-specific and customize the look and feel of a theme
170
# further.  For a list of options available for each theme, see the
171
# documentation.
172
#html_theme_options = {}
173

    
174
# Add any paths that contain custom themes here, relative to this directory.
175
#html_theme_path = []
176

    
177
# The name for this set of Sphinx documents.  If None, it defaults to
178
# "<project> v<release> documentation".
179
#html_title = None
180

    
181
# A shorter title for the navigation bar.  Default is the same as html_title.
182
#html_short_title = None
183

    
184
# The name of an image file (relative to this directory) to place at the top
185
# of the sidebar.
186
#html_logo = None
187

    
188
# The name of an image file (within the static path) to use as favicon of the
189
# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
190
# pixels large.
191
#html_favicon = None
192

    
193
# Add any paths that contain custom static files (such as style sheets) here,
194
# relative to this directory. They are copied after the builtin static files,
195
# so a file named "default.css" will overwrite the builtin "default.css".
196
html_static_path = ['_static']
197

    
198
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
199
# using the given strftime format.
200
#html_last_updated_fmt = '%b %d, %Y'
201

    
202
# If true, SmartyPants will be used to convert quotes and dashes to
203
# typographically correct entities.
204
#html_use_smartypants = True
205

    
206
# Custom sidebar templates, maps document names to template names.
207
#html_sidebars = {}
208

    
209
# Additional templates that should be rendered to pages, maps page names to
210
# template names.
211
#html_additional_pages = {}
212

    
213
# If false, no module index is generated.
214
#html_domain_indices = True
215

    
216
# If false, no index is generated.
217
#html_use_index = True
218

    
219
# If true, the index is split into individual pages for each letter.
220
#html_split_index = False
221

    
222
# If true, links to the reST sources are added to the pages.
223
#html_show_sourcelink = True
224

    
225
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
226
#html_show_sphinx = True
227

    
228
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
229
#html_show_copyright = True
230

    
231
# If true, an OpenSearch description file will be output, and all pages will
232
# contain a <link> tag referring to it.  The value of this option must be the
233
# base URL from which the finished HTML is served.
234
#html_use_opensearch = ''
235

    
236
# This is the file name suffix for HTML files (e.g. ".xhtml").
237
#html_file_suffix = None
238

    
239
# Output file base name for HTML help builder.
240
htmlhelp_basename = 'Kamakidoc'
241

    
242

    
243
# -- Options for LaTeX output ------------------------------------------------
244

    
245
latex_elements = {
246
# The paper size ('letterpaper' or 'a4paper').
247
#'papersize': 'letterpaper',
248

    
249
# The font size ('10pt', '11pt' or '12pt').
250
#'pointsize': '10pt',
251

    
252
# Additional stuff for the LaTeX preamble.
253
#'preamble': '',
254
}
255

    
256
# Grouping the document tree into LaTeX files. List of tuples
257
# (source start file, target name, title, author, documentclass
258
# [howto/manual]).
259
latex_documents = [
260
  ('index', 'Kamaki.tex', u'Kamaki Documentation',
261
   u'GRNET', 'manual'),
262
]
263

    
264
# The name of an image file (relative to this directory) to place at the top of
265
# the title page.
266
#latex_logo = None
267

    
268
# For "manual" documents, if this is true, then toplevel headings are parts,
269
# not chapters.
270
#latex_use_parts = False
271

    
272
# If true, show page references after internal links.
273
#latex_show_pagerefs = False
274

    
275
# If true, show URL addresses after external links.
276
#latex_show_urls = False
277

    
278
# Documents to append as an appendix to all manuals.
279
#latex_appendices = []
280

    
281
# If false, no module index is generated.
282
#latex_domain_indices = True
283

    
284

    
285
# -- Options for manual page output ------------------------------------------
286

    
287
# One entry per manual page. List of tuples
288
# (source start file, name, description, authors, manual section).
289
man_pages = [
290
    ('man/kamaki', 'kamaki', 'Command-line tool for managing clouds', '', 1),
291
]
292

    
293
# If true, show URL addresses after external links.
294
#man_show_urls = False
295

    
296

    
297
# -- Options for Texinfo output ----------------------------------------------
298

    
299
# Grouping the document tree into Texinfo files. List of tuples
300
# (source start file, target name, title, author,
301
#  dir menu entry, description, category)
302
texinfo_documents = [
303
  ('index', 'Kamaki', u'Kamaki Documentation',
304
   u'GRNET', 'Kamaki', 'One line description of project.',
305
   'Miscellaneous'),
306
]
307

    
308
# Documents to append as an appendix to all manuals.
309
#texinfo_appendices = []
310

    
311
# If false, no module index is generated.
312
#texinfo_domain_indices = True
313

    
314
# How to display URL addresses: 'footnote', 'no', or 'inline'.
315
#texinfo_show_urls = 'footnote'