conf.py 11.1 KB
Newer Older
1
2
# -*- coding: utf-8 -*-
#
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
# Copyright 2011-2013 GRNET S.A. All rights reserved.
#
# Redistribution and use in source and binary forms, with or
# without modification, are permitted provided that the following
# conditions are met:
#
#   1. Redistributions of source code must retain the above
#      copyright notice, this list of conditions and the following
#      disclaimer.
#
#   2. Redistributions in binary form must reproduce the above
#      copyright notice, this list of conditions and the following
#      disclaimer in the documentation and/or other materials
#      provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
# OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
# AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
#
# The views and conclusions contained in the software and
# documentation are those of the authors and should not be
# interpreted as representing official policies, either expressed
# or implied, of GRNET S.A.
#
#
#
38
39
40
# Kamaki documentation build configuration file, created by
# sphinx-quickstart on Tue Nov 29 15:15:50 2011.
#
41
42
# This file is execfile()d with the current directory set to its containing
# dir.
43
44
#
# Note that not all possible configuration values are present in this
Stavros Sachtouris's avatar
Stavros Sachtouris committed
45
# auto-generated file.
46
47
48
49
50
51
52
53
#
# All configuration values have a default; values that are commented out
# serve to show the default.

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.

54
55
from sys import path, stderr
import os
56

57
58
59
60

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

61
try:
62
63
    from objpool.http import PooledHTTPConnection
    PooledHTTPConnection
64
except ImportError:
65
66
67
68
69
    path.insert(0, SITE_PACKAGES_PATH)
    try:
        from objpool.http import PooledHTTPConnection
        PooledHTTPConnection
    except ImportError:
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
        stderr.write('`objpool` package is required to build kamaki docs.\n')
        exit(1)


try:
    from astakosclient import AstakosClient
    AstakosClient
except ImportError:
    path.insert(0, '%s/%s' % (
        SITE_PACKAGES_PATH,
        'astakosclient-0.14.5next_10224_6c10f58-py2.7.egg'))
    try:
        from astakosclient import AstakosClient
        AstakosClient
    except ImportError:
        stderr.write(
            '`astakosclient` package is required to build kamaki docs.\n')
87
        exit(1)
88

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

Stavros Sachtouris's avatar
Docfix    
Stavros Sachtouris committed
101
path.insert(0, os.path.join(os.path.abspath(os.path.dirname(__file__)), '..'))
Kostas Papadimitriou's avatar
Kostas Papadimitriou committed
102

103
# -- General configuration ---------------------------------------------------
104
105
106
107

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

108
109
# Add any Sphinx extension module names here, as strings. They can be
#extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']

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

# The suffix of source filenames.
source_suffix = '.rst'

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

# The master toctree document.
master_doc = 'index'

# General information about the project.
project = u'Kamaki'
126
copyright = u'2013, GRNET'
127
128
129
130
131
132

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
133
version = '0.10'
134
# The full version, including alpha/beta/rc tags.
135
136
137
138
139
try:
    import kamaki
    release = kamaki.__version__
except ImportError:
    release = version
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154

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

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

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

155
156
# The reST default role (used for this markup: `text`) to use for all
# documents.
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
#default_role = None

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

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

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

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

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


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

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

205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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


280
# -- Options for LaTeX output ------------------------------------------------
281
282
283
284
285
286
287
288
289
290
291
292
293

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

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

# Additional stuff for the LaTeX preamble.
#'preamble': '',
}

# Grouping the document tree into LaTeX files. List of tuples
294
295
# (source start file, target name, title, author, documentclass
# [howto/manual]).
296
297
latex_documents = [
  ('index', 'Kamaki.tex', u'Kamaki Documentation',
298
   u'GRNET', 'manual'),
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
]

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

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

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

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

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

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


322
# -- Options for manual page output ------------------------------------------
323
324
325
326

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
Kostas Papadimitriou's avatar
Kostas Papadimitriou committed
327
    ('man/kamaki', 'kamaki', 'Command-line tool for managing clouds', '', 1),
328
329
330
331
332
333
]

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


334
# -- Options for Texinfo output ----------------------------------------------
335
336
337
338
339
340

# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
#  dir menu entry, description, category)
texinfo_documents = [
  ('index', 'Kamaki', u'Kamaki Documentation',
341
   u'GRNET', 'Kamaki', 'One line description of project.',
342
343
344
345
346
347
348
349
350
351
352
   'Miscellaneous'),
]

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

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

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