Statistics
| Branch: | Tag: | Revision:

root / docs / conf.py @ d4517eeb

History | View | Annotate | Download (11.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

    
58
SITE_PACKAGES_PATH = os.path.expanduser(
59
    '~/src/kamaki/docsenv/lib/python2.7/site-packages')
60

    
61
try:
62
    from objpool.http import PooledHTTPConnection
63
    PooledHTTPConnection
64
except ImportError:
65
    path.insert(0, SITE_PACKAGES_PATH)
66
    try:
67
        from objpool.http import PooledHTTPConnection
68
        PooledHTTPConnection
69
    except ImportError:
70
        stderr.write('`objpool` package is required to build kamaki docs.\n')
71
        exit(1)
72

    
73

    
74
try:
75
    from astakosclient import AstakosClient
76
    AstakosClient
77
except ImportError:
78
    path.insert(0, '%s/%s' % (
79
        SITE_PACKAGES_PATH,
80
        'astakosclient-0.14.5next_10224_6c10f58-py2.7.egg'))
81
    try:
82
        from astakosclient import AstakosClient
83
        AstakosClient
84
    except ImportError:
85
        stderr.write(
86
            '`astakosclient` package is required to build kamaki docs.\n')
87
        exit(1)
88

    
89
# try:
90
#     from progress.bar import ShadyBar
91
#     ShadyBar
92
# except ImportError:
93
#     path.insert(0, SITE_PACKAGES_PATH)
94
#     try:
95
#         from progress.bar import ShadyBar
96
#         ShadyBar
97
#     except ImportError:
98
#         stderr.write(
99
#           '`progress` package is suggested to build kamaki docs.\n')
100

    
101
path.insert(0, os.path.join(os.path.abspath(os.path.dirname(__file__)), '..'))
102

    
103
# -- General configuration ---------------------------------------------------
104

    
105
# If your documentation needs a minimal Sphinx version, state it here.
106
#needs_sphinx = '1.0'
107

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

    
112
# Add any paths that contain templates here, relative to this directory.
113
templates_path = ['_templates']
114

    
115
# The suffix of source filenames.
116
source_suffix = '.rst'
117

    
118
# The encoding of source files.
119
#source_encoding = 'utf-8-sig'
120

    
121
# The master toctree document.
122
master_doc = 'index'
123

    
124
# General information about the project.
125
project = u'Kamaki'
126
copyright = u'2013, GRNET'
127
# The version info for the project you're documenting, acts as replacement for
128
# |version| and |release|, also used in various other places throughout the
129
# built documents.
130
#
131
# The short X.Y version.
132
version = '0.12'
133
# The full version, including alpha/beta/rc tags.
134

    
135
try:
136
    import kamaki
137
    release = kamaki.__version__
138
except ImportError:
139
    release = version
140

    
141
# The language for content autogenerated by Sphinx. Refer to documentation
142
# for a list of supported languages.
143
#language = None
144

    
145
# There are two options for replacing |today|: either, you set today to some
146
# non-false value, then it is used:
147
#today = ''
148
# Else, today_fmt is used as the format for a strftime call.
149
#today_fmt = '%B %d, %Y'
150

    
151
# List of patterns, relative to source directory, that match files and
152
# directories to ignore when looking for source files.
153
exclude_patterns = ['_build']
154

    
155
# The reST default role (used for this markup: `text`) to use for all
156
# documents.
157
#default_role = None
158

    
159
# If true, '()' will be appended to :func: etc. cross-reference text.
160
#add_function_parentheses = True
161

    
162
# If true, the current module name will be prepended to all description
163
# unit titles (such as .. function::).
164
#add_module_names = True
165

    
166
# If true, sectionauthor and moduleauthor directives will be shown in the
167
# output. They are ignored by default.
168
#show_authors = False
169

    
170
# The name of the Pygments (syntax highlighting) style to use.
171
pygments_style = 'sphinx'
172

    
173
# A list of ignored prefixes for module index sorting.
174
#modindex_common_prefix = []
175

    
176

    
177
# -- Options for HTML output -------------------------------------------------
178

    
179
# The theme to use for HTML and HTML Help pages.  See the documentation for
180
# a list of builtin themes.
181
#html_theme = 'nature'
182
html_theme = 'default'
183
html_theme_options = {
184
    'collapsiblesidebar': 'true',
185
    'footerbgcolor':    '#55b577',
186
    'footertextcolor':  '#000000',
187
    'sidebarbgcolor':   '#ffffff',
188
    'sidebarbtncolor':  '#f2f2f2',
189
    'sidebartextcolor': '#000000',
190
    'sidebarlinkcolor': '#328e4a',
191
    'relbarbgcolor':    '#55b577',
192
    'relbartextcolor':  '#ffffff',
193
    'relbarlinkcolor':  '#ffffff',
194
    'bgcolor':          '#ffffff',
195
    'textcolor':        '#000000',
196
    'headbgcolor':      '#ffffff',
197
    'headtextcolor':    '#000000',
198
    'headlinkcolor':    '#c60f0f',
199
    'linkcolor':        '#328e4a',
200
    'visitedlinkcolor': '#63409b',
201
    'codebgcolor':      '#eeffcc',
202
    'codetextcolor':    '#333333'
203
}
204

    
205

    
206
# Theme options are theme-specific and customize the look and feel of a theme
207
# further.  For a list of options available for each theme, see the
208
# documentation.
209
#html_theme_options = {}
210

    
211
# Add any paths that contain custom themes here, relative to this directory.
212
#html_theme_path = []
213

    
214
# The name for this set of Sphinx documents.  If None, it defaults to
215
# "<project> v<release> documentation".
216
#html_title = None
217

    
218
# A shorter title for the navigation bar.  Default is the same as html_title.
219
#html_short_title = None
220

    
221
# The name of an image file (relative to this directory) to place at the top
222
# of the sidebar.
223
#html_logo = None
224

    
225
# The name of an image file (within the static path) to use as favicon of the
226
# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
227
# pixels large.
228
#html_favicon = None
229

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

    
235
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
236
# using the given strftime format.
237
#html_last_updated_fmt = '%b %d, %Y'
238

    
239
# If true, SmartyPants will be used to convert quotes and dashes to
240
# typographically correct entities.
241
#html_use_smartypants = True
242

    
243
# Custom sidebar templates, maps document names to template names.
244
#html_sidebars = {}
245

    
246
# Additional templates that should be rendered to pages, maps page names to
247
# template names.
248
#html_additional_pages = {}
249

    
250
# If false, no module index is generated.
251
#html_domain_indices = True
252

    
253
# If false, no index is generated.
254
#html_use_index = True
255

    
256
# If true, the index is split into individual pages for each letter.
257
#html_split_index = False
258

    
259
# If true, links to the reST sources are added to the pages.
260
#html_show_sourcelink = True
261

    
262
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
263
#html_show_sphinx = True
264

    
265
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
266
#html_show_copyright = True
267

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

    
273
# This is the file name suffix for HTML files (e.g. ".xhtml").
274
#html_file_suffix = None
275

    
276
# Output file base name for HTML help builder.
277
htmlhelp_basename = 'Kamakidoc'
278

    
279

    
280
# -- Options for LaTeX output ------------------------------------------------
281

    
282
latex_elements = {
283
# The paper size ('letterpaper' or 'a4paper').
284
#'papersize': 'letterpaper',
285

    
286
# The font size ('10pt', '11pt' or '12pt').
287
#'pointsize': '10pt',
288

    
289
# Additional stuff for the LaTeX preamble.
290
#'preamble': '',
291
}
292

    
293
# Grouping the document tree into LaTeX files. List of tuples
294
# (source start file, target name, title, author, documentclass
295
# [howto/manual]).
296
latex_documents = [
297
  ('index', 'Kamaki.tex', u'Kamaki Documentation',
298
   u'GRNET', 'manual'),
299
]
300

    
301
# The name of an image file (relative to this directory) to place at the top of
302
# the title page.
303
#latex_logo = None
304

    
305
# For "manual" documents, if this is true, then toplevel headings are parts,
306
# not chapters.
307
#latex_use_parts = False
308

    
309
# If true, show page references after internal links.
310
#latex_show_pagerefs = False
311

    
312
# If true, show URL addresses after external links.
313
#latex_show_urls = False
314

    
315
# Documents to append as an appendix to all manuals.
316
#latex_appendices = []
317

    
318
# If false, no module index is generated.
319
#latex_domain_indices = True
320

    
321

    
322
# -- Options for manual page output ------------------------------------------
323

    
324
# One entry per manual page. List of tuples
325
# (source start file, name, description, authors, manual section).
326
man_pages = [
327
    ('man/kamaki', 'kamaki', 'Command-line tool for managing clouds', '', 1),
328
]
329

    
330
# If true, show URL addresses after external links.
331
#man_show_urls = False
332

    
333

    
334
# -- Options for Texinfo output ----------------------------------------------
335

    
336
# Grouping the document tree into Texinfo files. List of tuples
337
# (source start file, target name, title, author,
338
#  dir menu entry, description, category)
339
texinfo_documents = [
340
  ('index', 'Kamaki', u'Kamaki Documentation',
341
   u'GRNET', 'Kamaki', 'One line description of project.',
342
   'Miscellaneous'),
343
]
344

    
345
# Documents to append as an appendix to all manuals.
346
#texinfo_appendices = []
347

    
348
# If false, no module index is generated.
349
#texinfo_domain_indices = True
350

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