Statistics
| Branch: | Tag: | Revision:

root / docs / conf.py @ 457cb69b

History | View | Annotate | Download (7.8 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 dir.
7
#
8
# Note that not all possible configuration values are present in this
9
# autogenerated file.
10
#
11
# All configuration values have a default; values that are commented out
12
# serve to show the default.
13

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

    
18
import sys, os
19

    
20
sys.path.append('/home/saxtouri/src/synnefo/snf-common')
21
try:
22
    from synnefo import lib
23
except ImportError:
24
    sys.stderr.write("`snf-common` package is required to build kamaki docs.\n")
25
    exit()
26

    
27
sys.path.append(os.path.join(os.path.abspath(os.path.dirname(__file__)),'..'))
28

    
29
# -- General configuration -----------------------------------------------------
30

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

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

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

    
41
# The suffix of source filenames.
42
source_suffix = '.rst'
43

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

    
47
# The master toctree document.
48
master_doc = 'index'
49

    
50
# General information about the project.
51
project = u'Kamaki'
52
copyright = u'2012, GRNet'
53

    
54
# The version info for the project you're documenting, acts as replacement for
55
# |version| and |release|, also used in various other places throughout the
56
# built documents.
57
#
58
# The short X.Y version.
59
version = '0.6'
60
# The full version, including alpha/beta/rc tags.
61
release = '0.6.1'
62

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

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

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

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

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

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

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

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

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

    
97

    
98
# -- Options for HTML output ---------------------------------------------------
99

    
100
# The theme to use for HTML and HTML Help pages.  See the documentation for
101
# a list of builtin themes.
102
html_theme = 'nature'
103

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    
177

    
178
# -- Options for LaTeX output --------------------------------------------------
179

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

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

    
187
# Additional stuff for the LaTeX preamble.
188
#'preamble': '',
189
}
190

    
191
# Grouping the document tree into LaTeX files. List of tuples
192
# (source start file, target name, title, author, documentclass [howto/manual]).
193
latex_documents = [
194
  ('index', 'Kamaki.tex', u'Kamaki Documentation',
195
   u'GRNet', 'manual'),
196
]
197

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

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

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

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

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

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

    
218

    
219
# -- Options for manual page output --------------------------------------------
220

    
221
# One entry per manual page. List of tuples
222
# (source start file, name, description, authors, manual section).
223
man_pages = [
224
    ('man/kamaki', 'kamaki', 'Command-line tool for managing clouds', '', 1),
225
]
226

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

    
230

    
231
# -- Options for Texinfo output ------------------------------------------------
232

    
233
# Grouping the document tree into Texinfo files. List of tuples
234
# (source start file, target name, title, author,
235
#  dir menu entry, description, category)
236
texinfo_documents = [
237
  ('index', 'Kamaki', u'Kamaki Documentation',
238
   u'GRNet', 'Kamaki', 'One line description of project.',
239
   'Miscellaneous'),
240
]
241

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

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

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