Statistics
| Branch: | Tag: | Revision:

root / docs / conf.py @ db77d79e

History | View | Annotate | Download (8.5 kB)

1
# -*- coding: utf-8 -*-
2
#
3
# Kamaki documentation build configuration file, created by
4
# sphinx-quickstart on Tue Nov 29 15:15:50 2011.
5
#
6
# This file is execfile()d with the current directory set to its containing
7
# dir.
8
#
9
# Note that not all possible configuration values are present in this
10
# auto-generated file.
11
#
12
# All configuration values have a default; values that are commented out
13
# serve to show the default.
14

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

    
19
from sys import path, stderr
20
import os
21

    
22
try:
23
    from objpool import http
24
    http
25
except ImportError:
26
    stderr.write("`objpool` package is required to build kamaki docs.\n")
27
    #exit()
28

    
29
path.insert(0, os.path.join(os.path.abspath(os.path.dirname(__file__)), '..'))
30

    
31
# -- General configuration ---------------------------------------------------
32

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

    
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']
39

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

    
43
# The suffix of source filenames.
44
source_suffix = '.rst'
45

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

    
49
# The master toctree document.
50
master_doc = 'index'
51

    
52
# General information about the project.
53
project = u'Kamaki'
54
copyright = u'2012, GRNET'
55

    
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
58
# built documents.
59
#
60
# The short X.Y version.
61
version = '0.6'
62
# The full version, including alpha/beta/rc tags.
63
release = '0.6.3'
64

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

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

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

    
79
# The reST default role (used for this markup: `text`) to use for all
80
# documents.
81
#default_role = None
82

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

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

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

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

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

    
100

    
101
# -- Options for HTML output -------------------------------------------------
102

    
103
# The theme to use for HTML and HTML Help pages.  See the documentation for
104
# a list of builtin themes.
105
#html_theme = 'nature'
106
html_theme = 'default'
107
html_theme_options = {
108
    'collapsiblesidebar': 'true',
109
    'footerbgcolor':    '#55b577',
110
    'footertextcolor':  '#000000',
111
    'sidebarbgcolor':   '#ffffff',
112
    'sidebarbtncolor':  '#f2f2f2',
113
    'sidebartextcolor': '#000000',
114
    'sidebarlinkcolor': '#328e4a',
115
    'relbarbgcolor':    '#55b577',
116
    'relbartextcolor':  '#ffffff',
117
    'relbarlinkcolor':  '#ffffff',
118
    'bgcolor':          '#ffffff',
119
    'textcolor':        '#000000',
120
    'headbgcolor':      '#ffffff',
121
    'headtextcolor':    '#000000',
122
    'headlinkcolor':    '#c60f0f',
123
    'linkcolor':        '#328e4a',
124
    'visitedlinkcolor': '#63409b',
125
    'codebgcolor':      '#eeffcc',
126
    'codetextcolor':    '#333333'
127
}
128

    
129

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    
203

    
204
# -- Options for LaTeX output ------------------------------------------------
205

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

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

    
213
# Additional stuff for the LaTeX preamble.
214
#'preamble': '',
215
}
216

    
217
# Grouping the document tree into LaTeX files. List of tuples
218
# (source start file, target name, title, author, documentclass
219
# [howto/manual]).
220
latex_documents = [
221
  ('index', 'Kamaki.tex', u'Kamaki Documentation',
222
   u'GRNET', 'manual'),
223
]
224

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

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

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

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

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

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

    
245

    
246
# -- Options for manual page output ------------------------------------------
247

    
248
# One entry per manual page. List of tuples
249
# (source start file, name, description, authors, manual section).
250
man_pages = [
251
    ('man/kamaki', 'kamaki', 'Command-line tool for managing clouds', '', 1),
252
]
253

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

    
257

    
258
# -- Options for Texinfo output ----------------------------------------------
259

    
260
# Grouping the document tree into Texinfo files. List of tuples
261
# (source start file, target name, title, author,
262
#  dir menu entry, description, category)
263
texinfo_documents = [
264
  ('index', 'Kamaki', u'Kamaki Documentation',
265
   u'GRNET', 'Kamaki', 'One line description of project.',
266
   'Miscellaneous'),
267
]
268

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

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

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