root / docs / conf.py @ 2bd23362
History | View | Annotate | Download (10.6 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 |
try:
|
74 |
from progress.bar import ShadyBar |
75 |
ShadyBar |
76 |
except ImportError: |
77 |
path.insert(0, SITE_PACKAGES_PATH)
|
78 |
try:
|
79 |
from progress.bar import ShadyBar |
80 |
ShadyBar |
81 |
except ImportError: |
82 |
stderr.write("`progress` package is required to build kamaki docs.\n")
|
83 |
exit(1) |
84 |
|
85 |
path.insert(0, os.path.join(os.path.abspath(os.path.dirname(__file__)), '..')) |
86 |
|
87 |
# -- General configuration ---------------------------------------------------
|
88 |
|
89 |
# If your documentation needs a minimal Sphinx version, state it here.
|
90 |
#needs_sphinx = '1.0'
|
91 |
|
92 |
# Add any Sphinx extension module names here, as strings. They can be
|
93 |
#extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
94 |
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode'] |
95 |
|
96 |
# Add any paths that contain templates here, relative to this directory.
|
97 |
templates_path = ['_templates']
|
98 |
|
99 |
# The suffix of source filenames.
|
100 |
source_suffix = '.rst'
|
101 |
|
102 |
# The encoding of source files.
|
103 |
#source_encoding = 'utf-8-sig'
|
104 |
|
105 |
# The master toctree document.
|
106 |
master_doc = 'index'
|
107 |
|
108 |
# General information about the project.
|
109 |
project = u'Kamaki'
|
110 |
copyright = u'2013, GRNET'
|
111 |
|
112 |
# The version info for the project you're documenting, acts as replacement for
|
113 |
# |version| and |release|, also used in various other places throughout the
|
114 |
# built documents.
|
115 |
#
|
116 |
# The short X.Y version.
|
117 |
version = '0.10'
|
118 |
# The full version, including alpha/beta/rc tags.
|
119 |
try:
|
120 |
import kamaki |
121 |
release = kamaki.__version__ |
122 |
except ImportError: |
123 |
release = version |
124 |
|
125 |
# The language for content autogenerated by Sphinx. Refer to documentation
|
126 |
# for a list of supported languages.
|
127 |
#language = None
|
128 |
|
129 |
# There are two options for replacing |today|: either, you set today to some
|
130 |
# non-false value, then it is used:
|
131 |
#today = ''
|
132 |
# Else, today_fmt is used as the format for a strftime call.
|
133 |
#today_fmt = '%B %d, %Y'
|
134 |
|
135 |
# List of patterns, relative to source directory, that match files and
|
136 |
# directories to ignore when looking for source files.
|
137 |
exclude_patterns = ['_build']
|
138 |
|
139 |
# The reST default role (used for this markup: `text`) to use for all
|
140 |
# documents.
|
141 |
#default_role = None
|
142 |
|
143 |
# If true, '()' will be appended to :func: etc. cross-reference text.
|
144 |
#add_function_parentheses = True
|
145 |
|
146 |
# If true, the current module name will be prepended to all description
|
147 |
# unit titles (such as .. function::).
|
148 |
#add_module_names = True
|
149 |
|
150 |
# If true, sectionauthor and moduleauthor directives will be shown in the
|
151 |
# output. They are ignored by default.
|
152 |
#show_authors = False
|
153 |
|
154 |
# The name of the Pygments (syntax highlighting) style to use.
|
155 |
pygments_style = 'sphinx'
|
156 |
|
157 |
# A list of ignored prefixes for module index sorting.
|
158 |
#modindex_common_prefix = []
|
159 |
|
160 |
|
161 |
# -- Options for HTML output -------------------------------------------------
|
162 |
|
163 |
# The theme to use for HTML and HTML Help pages. See the documentation for
|
164 |
# a list of builtin themes.
|
165 |
#html_theme = 'nature'
|
166 |
html_theme = 'default'
|
167 |
html_theme_options = { |
168 |
'collapsiblesidebar': 'true', |
169 |
'footerbgcolor': '#55b577', |
170 |
'footertextcolor': '#000000', |
171 |
'sidebarbgcolor': '#ffffff', |
172 |
'sidebarbtncolor': '#f2f2f2', |
173 |
'sidebartextcolor': '#000000', |
174 |
'sidebarlinkcolor': '#328e4a', |
175 |
'relbarbgcolor': '#55b577', |
176 |
'relbartextcolor': '#ffffff', |
177 |
'relbarlinkcolor': '#ffffff', |
178 |
'bgcolor': '#ffffff', |
179 |
'textcolor': '#000000', |
180 |
'headbgcolor': '#ffffff', |
181 |
'headtextcolor': '#000000', |
182 |
'headlinkcolor': '#c60f0f', |
183 |
'linkcolor': '#328e4a', |
184 |
'visitedlinkcolor': '#63409b', |
185 |
'codebgcolor': '#eeffcc', |
186 |
'codetextcolor': '#333333' |
187 |
} |
188 |
|
189 |
|
190 |
# Theme options are theme-specific and customize the look and feel of a theme
|
191 |
# further. For a list of options available for each theme, see the
|
192 |
# documentation.
|
193 |
#html_theme_options = {}
|
194 |
|
195 |
# Add any paths that contain custom themes here, relative to this directory.
|
196 |
#html_theme_path = []
|
197 |
|
198 |
# The name for this set of Sphinx documents. If None, it defaults to
|
199 |
# "<project> v<release> documentation".
|
200 |
#html_title = None
|
201 |
|
202 |
# A shorter title for the navigation bar. Default is the same as html_title.
|
203 |
#html_short_title = None
|
204 |
|
205 |
# The name of an image file (relative to this directory) to place at the top
|
206 |
# of the sidebar.
|
207 |
#html_logo = None
|
208 |
|
209 |
# The name of an image file (within the static path) to use as favicon of the
|
210 |
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
211 |
# pixels large.
|
212 |
#html_favicon = None
|
213 |
|
214 |
# Add any paths that contain custom static files (such as style sheets) here,
|
215 |
# relative to this directory. They are copied after the builtin static files,
|
216 |
# so a file named "default.css" will overwrite the builtin "default.css".
|
217 |
html_static_path = ['_static']
|
218 |
|
219 |
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
220 |
# using the given strftime format.
|
221 |
#html_last_updated_fmt = '%b %d, %Y'
|
222 |
|
223 |
# If true, SmartyPants will be used to convert quotes and dashes to
|
224 |
# typographically correct entities.
|
225 |
#html_use_smartypants = True
|
226 |
|
227 |
# Custom sidebar templates, maps document names to template names.
|
228 |
#html_sidebars = {}
|
229 |
|
230 |
# Additional templates that should be rendered to pages, maps page names to
|
231 |
# template names.
|
232 |
#html_additional_pages = {}
|
233 |
|
234 |
# If false, no module index is generated.
|
235 |
#html_domain_indices = True
|
236 |
|
237 |
# If false, no index is generated.
|
238 |
#html_use_index = True
|
239 |
|
240 |
# If true, the index is split into individual pages for each letter.
|
241 |
#html_split_index = False
|
242 |
|
243 |
# If true, links to the reST sources are added to the pages.
|
244 |
#html_show_sourcelink = True
|
245 |
|
246 |
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
247 |
#html_show_sphinx = True
|
248 |
|
249 |
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
250 |
#html_show_copyright = True
|
251 |
|
252 |
# If true, an OpenSearch description file will be output, and all pages will
|
253 |
# contain a <link> tag referring to it. The value of this option must be the
|
254 |
# base URL from which the finished HTML is served.
|
255 |
#html_use_opensearch = ''
|
256 |
|
257 |
# This is the file name suffix for HTML files (e.g. ".xhtml").
|
258 |
#html_file_suffix = None
|
259 |
|
260 |
# Output file base name for HTML help builder.
|
261 |
htmlhelp_basename = 'Kamakidoc'
|
262 |
|
263 |
|
264 |
# -- Options for LaTeX output ------------------------------------------------
|
265 |
|
266 |
latex_elements = { |
267 |
# The paper size ('letterpaper' or 'a4paper').
|
268 |
#'papersize': 'letterpaper',
|
269 |
|
270 |
# The font size ('10pt', '11pt' or '12pt').
|
271 |
#'pointsize': '10pt',
|
272 |
|
273 |
# Additional stuff for the LaTeX preamble.
|
274 |
#'preamble': '',
|
275 |
} |
276 |
|
277 |
# Grouping the document tree into LaTeX files. List of tuples
|
278 |
# (source start file, target name, title, author, documentclass
|
279 |
# [howto/manual]).
|
280 |
latex_documents = [ |
281 |
('index', 'Kamaki.tex', u'Kamaki Documentation', |
282 |
u'GRNET', 'manual'), |
283 |
] |
284 |
|
285 |
# The name of an image file (relative to this directory) to place at the top of
|
286 |
# the title page.
|
287 |
#latex_logo = None
|
288 |
|
289 |
# For "manual" documents, if this is true, then toplevel headings are parts,
|
290 |
# not chapters.
|
291 |
#latex_use_parts = False
|
292 |
|
293 |
# If true, show page references after internal links.
|
294 |
#latex_show_pagerefs = False
|
295 |
|
296 |
# If true, show URL addresses after external links.
|
297 |
#latex_show_urls = False
|
298 |
|
299 |
# Documents to append as an appendix to all manuals.
|
300 |
#latex_appendices = []
|
301 |
|
302 |
# If false, no module index is generated.
|
303 |
#latex_domain_indices = True
|
304 |
|
305 |
|
306 |
# -- Options for manual page output ------------------------------------------
|
307 |
|
308 |
# One entry per manual page. List of tuples
|
309 |
# (source start file, name, description, authors, manual section).
|
310 |
man_pages = [ |
311 |
('man/kamaki', 'kamaki', 'Command-line tool for managing clouds', '', 1), |
312 |
] |
313 |
|
314 |
# If true, show URL addresses after external links.
|
315 |
#man_show_urls = False
|
316 |
|
317 |
|
318 |
# -- Options for Texinfo output ----------------------------------------------
|
319 |
|
320 |
# Grouping the document tree into Texinfo files. List of tuples
|
321 |
# (source start file, target name, title, author,
|
322 |
# dir menu entry, description, category)
|
323 |
texinfo_documents = [ |
324 |
('index', 'Kamaki', u'Kamaki Documentation', |
325 |
u'GRNET', 'Kamaki', 'One line description of project.', |
326 |
'Miscellaneous'),
|
327 |
] |
328 |
|
329 |
# Documents to append as an appendix to all manuals.
|
330 |
#texinfo_appendices = []
|
331 |
|
332 |
# If false, no module index is generated.
|
333 |
#texinfo_domain_indices = True
|
334 |
|
335 |
# How to display URL addresses: 'footnote', 'no', or 'inline'.
|
336 |
#texinfo_show_urls = 'footnote'
|