root / docs / source / conf.py @ 6efed609
History | View | Annotate | Download (8.5 kB)
1 | 52271184 | Kostas Papadimitriou | # Copyright 2012 GRNET S.A. All rights reserved.
|
---|---|---|---|
2 | 52271184 | Kostas Papadimitriou | #
|
3 | 52271184 | Kostas Papadimitriou | # Redistribution and use in source and binary forms, with or
|
4 | 52271184 | Kostas Papadimitriou | # without modification, are permitted provided that the following
|
5 | 52271184 | Kostas Papadimitriou | # conditions are met:
|
6 | 52271184 | Kostas Papadimitriou | #
|
7 | 52271184 | Kostas Papadimitriou | # 1. Redistributions of source code must retain the above
|
8 | 52271184 | Kostas Papadimitriou | # copyright notice, this list of conditions and the following
|
9 | 52271184 | Kostas Papadimitriou | # disclaimer.
|
10 | 52271184 | Kostas Papadimitriou | #
|
11 | 52271184 | Kostas Papadimitriou | # 2. Redistributions in binary form must reproduce the above
|
12 | 52271184 | Kostas Papadimitriou | # copyright notice, this list of conditions and the following
|
13 | 52271184 | Kostas Papadimitriou | # disclaimer in the documentation and/or other materials
|
14 | 52271184 | Kostas Papadimitriou | # provided with the distribution.
|
15 | 52271184 | Kostas Papadimitriou | #
|
16 | 52271184 | Kostas Papadimitriou | # THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
|
17 | 52271184 | Kostas Papadimitriou | # OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
18 | 52271184 | Kostas Papadimitriou | # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
19 | 52271184 | Kostas Papadimitriou | # PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
|
20 | 52271184 | Kostas Papadimitriou | # CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
21 | 52271184 | Kostas Papadimitriou | # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
22 | 52271184 | Kostas Papadimitriou | # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
|
23 | 52271184 | Kostas Papadimitriou | # USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
|
24 | 52271184 | Kostas Papadimitriou | # AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
25 | 52271184 | Kostas Papadimitriou | # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
|
26 | 52271184 | Kostas Papadimitriou | # ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
27 | 52271184 | Kostas Papadimitriou | # POSSIBILITY OF SUCH DAMAGE.
|
28 | 52271184 | Kostas Papadimitriou | #
|
29 | 52271184 | Kostas Papadimitriou | # The views and conclusions contained in the software and
|
30 | 52271184 | Kostas Papadimitriou | # documentation are those of the authors and should not be
|
31 | 52271184 | Kostas Papadimitriou | # interpreted as representing official policies, either expressed
|
32 | 52271184 | Kostas Papadimitriou | # or implied, of GRNET S.A.
|
33 | 52271184 | Kostas Papadimitriou | |
34 | 52271184 | Kostas Papadimitriou | |
35 | 872ca586 | Kostas Papadimitriou | # -*- coding: utf-8 -*-
|
36 | 872ca586 | Kostas Papadimitriou | #
|
37 | 872ca586 | Kostas Papadimitriou | # snf-cloudcms documentation build configuration file, created by
|
38 | 872ca586 | Kostas Papadimitriou | # sphinx-quickstart on Wed Feb 22 18:07:30 2012.
|
39 | 872ca586 | Kostas Papadimitriou | #
|
40 | 872ca586 | Kostas Papadimitriou | # This file is execfile()d with the current directory set to its containing dir.
|
41 | 872ca586 | Kostas Papadimitriou | #
|
42 | 872ca586 | Kostas Papadimitriou | # Note that not all possible configuration values are present in this
|
43 | 872ca586 | Kostas Papadimitriou | # autogenerated file.
|
44 | 872ca586 | Kostas Papadimitriou | #
|
45 | 872ca586 | Kostas Papadimitriou | # All configuration values have a default; values that are commented out
|
46 | 872ca586 | Kostas Papadimitriou | # serve to show the default.
|
47 | 872ca586 | Kostas Papadimitriou | |
48 | 872ca586 | Kostas Papadimitriou | import sys, os |
49 | 872ca586 | Kostas Papadimitriou | |
50 | 872ca586 | Kostas Papadimitriou | # If extensions (or modules to document with autodoc) are in another directory,
|
51 | 872ca586 | Kostas Papadimitriou | # add these directories to sys.path here. If the directory is relative to the
|
52 | 872ca586 | Kostas Papadimitriou | # documentation root, use os.path.abspath to make it absolute, like shown here.
|
53 | 872ca586 | Kostas Papadimitriou | #sys.path.insert(0, os.path.abspath('.'))
|
54 | 872ca586 | Kostas Papadimitriou | |
55 | 872ca586 | Kostas Papadimitriou | # -- General configuration -----------------------------------------------------
|
56 | 872ca586 | Kostas Papadimitriou | |
57 | 872ca586 | Kostas Papadimitriou | # If your documentation needs a minimal Sphinx version, state it here.
|
58 | 872ca586 | Kostas Papadimitriou | #needs_sphinx = '1.0'
|
59 | 872ca586 | Kostas Papadimitriou | |
60 | 872ca586 | Kostas Papadimitriou | # Add any Sphinx extension module names here, as strings. They can be extensions
|
61 | 872ca586 | Kostas Papadimitriou | # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
62 | 872ca586 | Kostas Papadimitriou | extensions = ['sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.viewcode'] |
63 | 872ca586 | Kostas Papadimitriou | |
64 | 872ca586 | Kostas Papadimitriou | # Add any paths that contain templates here, relative to this directory.
|
65 | 872ca586 | Kostas Papadimitriou | templates_path = ['_templates']
|
66 | 872ca586 | Kostas Papadimitriou | |
67 | 872ca586 | Kostas Papadimitriou | # The suffix of source filenames.
|
68 | 872ca586 | Kostas Papadimitriou | source_suffix = '.rst'
|
69 | 872ca586 | Kostas Papadimitriou | |
70 | 872ca586 | Kostas Papadimitriou | # The encoding of source files.
|
71 | 872ca586 | Kostas Papadimitriou | #source_encoding = 'utf-8-sig'
|
72 | 872ca586 | Kostas Papadimitriou | |
73 | 872ca586 | Kostas Papadimitriou | # The master toctree document.
|
74 | 872ca586 | Kostas Papadimitriou | master_doc = 'index'
|
75 | 872ca586 | Kostas Papadimitriou | |
76 | 872ca586 | Kostas Papadimitriou | # General information about the project.
|
77 | 872ca586 | Kostas Papadimitriou | project = u'snf-cloudcms'
|
78 | 872ca586 | Kostas Papadimitriou | copyright = u'2012, GRNET'
|
79 | 872ca586 | Kostas Papadimitriou | |
80 | 872ca586 | Kostas Papadimitriou | # The version info for the project you're documenting, acts as replacement for
|
81 | 872ca586 | Kostas Papadimitriou | # |version| and |release|, also used in various other places throughout the
|
82 | 872ca586 | Kostas Papadimitriou | # built documents.
|
83 | 872ca586 | Kostas Papadimitriou | #
|
84 | 872ca586 | Kostas Papadimitriou | # The short X.Y version.
|
85 | 872ca586 | Kostas Papadimitriou | version = '0.1'
|
86 | 872ca586 | Kostas Papadimitriou | # The full version, including alpha/beta/rc tags.
|
87 | 872ca586 | Kostas Papadimitriou | release = '0.1'
|
88 | 872ca586 | Kostas Papadimitriou | |
89 | 872ca586 | Kostas Papadimitriou | # The language for content autogenerated by Sphinx. Refer to documentation
|
90 | 872ca586 | Kostas Papadimitriou | # for a list of supported languages.
|
91 | 872ca586 | Kostas Papadimitriou | #language = None
|
92 | 872ca586 | Kostas Papadimitriou | |
93 | 872ca586 | Kostas Papadimitriou | # There are two options for replacing |today|: either, you set today to some
|
94 | 872ca586 | Kostas Papadimitriou | # non-false value, then it is used:
|
95 | 872ca586 | Kostas Papadimitriou | #today = ''
|
96 | 872ca586 | Kostas Papadimitriou | # Else, today_fmt is used as the format for a strftime call.
|
97 | 872ca586 | Kostas Papadimitriou | #today_fmt = '%B %d, %Y'
|
98 | 872ca586 | Kostas Papadimitriou | |
99 | 872ca586 | Kostas Papadimitriou | # List of patterns, relative to source directory, that match files and
|
100 | 872ca586 | Kostas Papadimitriou | # directories to ignore when looking for source files.
|
101 | 872ca586 | Kostas Papadimitriou | exclude_patterns = [] |
102 | 872ca586 | Kostas Papadimitriou | |
103 | 872ca586 | Kostas Papadimitriou | # The reST default role (used for this markup: `text`) to use for all documents.
|
104 | 872ca586 | Kostas Papadimitriou | #default_role = None
|
105 | 872ca586 | Kostas Papadimitriou | |
106 | 872ca586 | Kostas Papadimitriou | # If true, '()' will be appended to :func: etc. cross-reference text.
|
107 | 872ca586 | Kostas Papadimitriou | #add_function_parentheses = True
|
108 | 872ca586 | Kostas Papadimitriou | |
109 | 872ca586 | Kostas Papadimitriou | # If true, the current module name will be prepended to all description
|
110 | 872ca586 | Kostas Papadimitriou | # unit titles (such as .. function::).
|
111 | 872ca586 | Kostas Papadimitriou | #add_module_names = True
|
112 | 872ca586 | Kostas Papadimitriou | |
113 | 872ca586 | Kostas Papadimitriou | # If true, sectionauthor and moduleauthor directives will be shown in the
|
114 | 872ca586 | Kostas Papadimitriou | # output. They are ignored by default.
|
115 | 872ca586 | Kostas Papadimitriou | #show_authors = False
|
116 | 872ca586 | Kostas Papadimitriou | |
117 | 872ca586 | Kostas Papadimitriou | # The name of the Pygments (syntax highlighting) style to use.
|
118 | 872ca586 | Kostas Papadimitriou | pygments_style = 'sphinx'
|
119 | 872ca586 | Kostas Papadimitriou | |
120 | 872ca586 | Kostas Papadimitriou | # A list of ignored prefixes for module index sorting.
|
121 | 872ca586 | Kostas Papadimitriou | #modindex_common_prefix = []
|
122 | 872ca586 | Kostas Papadimitriou | |
123 | 872ca586 | Kostas Papadimitriou | |
124 | 872ca586 | Kostas Papadimitriou | # -- Options for HTML output ---------------------------------------------------
|
125 | 872ca586 | Kostas Papadimitriou | |
126 | 872ca586 | Kostas Papadimitriou | # The theme to use for HTML and HTML Help pages. See the documentation for
|
127 | 872ca586 | Kostas Papadimitriou | # a list of builtin themes.
|
128 | 872ca586 | Kostas Papadimitriou | html_theme = 'default'
|
129 | 872ca586 | Kostas Papadimitriou | |
130 | 872ca586 | Kostas Papadimitriou | # Theme options are theme-specific and customize the look and feel of a theme
|
131 | 872ca586 | Kostas Papadimitriou | # further. For a list of options available for each theme, see the
|
132 | 872ca586 | Kostas Papadimitriou | # documentation.
|
133 | 872ca586 | Kostas Papadimitriou | #html_theme_options = {}
|
134 | 872ca586 | Kostas Papadimitriou | |
135 | 872ca586 | Kostas Papadimitriou | # Add any paths that contain custom themes here, relative to this directory.
|
136 | 872ca586 | Kostas Papadimitriou | #html_theme_path = []
|
137 | 872ca586 | Kostas Papadimitriou | |
138 | 872ca586 | Kostas Papadimitriou | # The name for this set of Sphinx documents. If None, it defaults to
|
139 | 872ca586 | Kostas Papadimitriou | # "<project> v<release> documentation".
|
140 | 872ca586 | Kostas Papadimitriou | #html_title = None
|
141 | 872ca586 | Kostas Papadimitriou | |
142 | 872ca586 | Kostas Papadimitriou | # A shorter title for the navigation bar. Default is the same as html_title.
|
143 | 872ca586 | Kostas Papadimitriou | #html_short_title = None
|
144 | 872ca586 | Kostas Papadimitriou | |
145 | 872ca586 | Kostas Papadimitriou | # The name of an image file (relative to this directory) to place at the top
|
146 | 872ca586 | Kostas Papadimitriou | # of the sidebar.
|
147 | 872ca586 | Kostas Papadimitriou | #html_logo = None
|
148 | 872ca586 | Kostas Papadimitriou | |
149 | 872ca586 | Kostas Papadimitriou | # The name of an image file (within the static path) to use as favicon of the
|
150 | 872ca586 | Kostas Papadimitriou | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
151 | 872ca586 | Kostas Papadimitriou | # pixels large.
|
152 | 872ca586 | Kostas Papadimitriou | #html_favicon = None
|
153 | 872ca586 | Kostas Papadimitriou | |
154 | 872ca586 | Kostas Papadimitriou | # Add any paths that contain custom static files (such as style sheets) here,
|
155 | 872ca586 | Kostas Papadimitriou | # relative to this directory. They are copied after the builtin static files,
|
156 | 872ca586 | Kostas Papadimitriou | # so a file named "default.css" will overwrite the builtin "default.css".
|
157 | 872ca586 | Kostas Papadimitriou | html_static_path = ['_static']
|
158 | 872ca586 | Kostas Papadimitriou | |
159 | 872ca586 | Kostas Papadimitriou | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
160 | 872ca586 | Kostas Papadimitriou | # using the given strftime format.
|
161 | 872ca586 | Kostas Papadimitriou | #html_last_updated_fmt = '%b %d, %Y'
|
162 | 872ca586 | Kostas Papadimitriou | |
163 | 872ca586 | Kostas Papadimitriou | # If true, SmartyPants will be used to convert quotes and dashes to
|
164 | 872ca586 | Kostas Papadimitriou | # typographically correct entities.
|
165 | 872ca586 | Kostas Papadimitriou | #html_use_smartypants = True
|
166 | 872ca586 | Kostas Papadimitriou | |
167 | 872ca586 | Kostas Papadimitriou | # Custom sidebar templates, maps document names to template names.
|
168 | 872ca586 | Kostas Papadimitriou | #html_sidebars = {}
|
169 | 872ca586 | Kostas Papadimitriou | |
170 | 872ca586 | Kostas Papadimitriou | # Additional templates that should be rendered to pages, maps page names to
|
171 | 872ca586 | Kostas Papadimitriou | # template names.
|
172 | 872ca586 | Kostas Papadimitriou | #html_additional_pages = {}
|
173 | 872ca586 | Kostas Papadimitriou | |
174 | 872ca586 | Kostas Papadimitriou | # If false, no module index is generated.
|
175 | 872ca586 | Kostas Papadimitriou | #html_domain_indices = True
|
176 | 872ca586 | Kostas Papadimitriou | |
177 | 872ca586 | Kostas Papadimitriou | # If false, no index is generated.
|
178 | 872ca586 | Kostas Papadimitriou | #html_use_index = True
|
179 | 872ca586 | Kostas Papadimitriou | |
180 | 872ca586 | Kostas Papadimitriou | # If true, the index is split into individual pages for each letter.
|
181 | 872ca586 | Kostas Papadimitriou | #html_split_index = False
|
182 | 872ca586 | Kostas Papadimitriou | |
183 | 872ca586 | Kostas Papadimitriou | # If true, links to the reST sources are added to the pages.
|
184 | 872ca586 | Kostas Papadimitriou | #html_show_sourcelink = True
|
185 | 872ca586 | Kostas Papadimitriou | |
186 | 872ca586 | Kostas Papadimitriou | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
187 | 872ca586 | Kostas Papadimitriou | #html_show_sphinx = True
|
188 | 872ca586 | Kostas Papadimitriou | |
189 | 872ca586 | Kostas Papadimitriou | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
190 | 872ca586 | Kostas Papadimitriou | #html_show_copyright = True
|
191 | 872ca586 | Kostas Papadimitriou | |
192 | 872ca586 | Kostas Papadimitriou | # If true, an OpenSearch description file will be output, and all pages will
|
193 | 872ca586 | Kostas Papadimitriou | # contain a <link> tag referring to it. The value of this option must be the
|
194 | 872ca586 | Kostas Papadimitriou | # base URL from which the finished HTML is served.
|
195 | 872ca586 | Kostas Papadimitriou | #html_use_opensearch = ''
|
196 | 872ca586 | Kostas Papadimitriou | |
197 | 872ca586 | Kostas Papadimitriou | # This is the file name suffix for HTML files (e.g. ".xhtml").
|
198 | 872ca586 | Kostas Papadimitriou | #html_file_suffix = None
|
199 | 872ca586 | Kostas Papadimitriou | |
200 | 872ca586 | Kostas Papadimitriou | # Output file base name for HTML help builder.
|
201 | 872ca586 | Kostas Papadimitriou | htmlhelp_basename = 'snf-cloudcmsdoc'
|
202 | 872ca586 | Kostas Papadimitriou | |
203 | 872ca586 | Kostas Papadimitriou | |
204 | 872ca586 | Kostas Papadimitriou | # -- Options for LaTeX output --------------------------------------------------
|
205 | 872ca586 | Kostas Papadimitriou | |
206 | 872ca586 | Kostas Papadimitriou | # The paper size ('letter' or 'a4').
|
207 | 872ca586 | Kostas Papadimitriou | #latex_paper_size = 'letter'
|
208 | 872ca586 | Kostas Papadimitriou | |
209 | 872ca586 | Kostas Papadimitriou | # The font size ('10pt', '11pt' or '12pt').
|
210 | 872ca586 | Kostas Papadimitriou | #latex_font_size = '10pt'
|
211 | 872ca586 | Kostas Papadimitriou | |
212 | 872ca586 | Kostas Papadimitriou | # Grouping the document tree into LaTeX files. List of tuples
|
213 | 872ca586 | Kostas Papadimitriou | # (source start file, target name, title, author, documentclass [howto/manual]).
|
214 | 872ca586 | Kostas Papadimitriou | latex_documents = [ |
215 | 872ca586 | Kostas Papadimitriou | ('index', 'snf-cloudcms.tex', u'snf-cloudcms Documentation', |
216 | 872ca586 | Kostas Papadimitriou | u'GRNET', 'manual'), |
217 | 872ca586 | Kostas Papadimitriou | ] |
218 | 872ca586 | Kostas Papadimitriou | |
219 | 872ca586 | Kostas Papadimitriou | # The name of an image file (relative to this directory) to place at the top of
|
220 | 872ca586 | Kostas Papadimitriou | # the title page.
|
221 | 872ca586 | Kostas Papadimitriou | #latex_logo = None
|
222 | 872ca586 | Kostas Papadimitriou | |
223 | 872ca586 | Kostas Papadimitriou | # For "manual" documents, if this is true, then toplevel headings are parts,
|
224 | 872ca586 | Kostas Papadimitriou | # not chapters.
|
225 | 872ca586 | Kostas Papadimitriou | #latex_use_parts = False
|
226 | 872ca586 | Kostas Papadimitriou | |
227 | 872ca586 | Kostas Papadimitriou | # If true, show page references after internal links.
|
228 | 872ca586 | Kostas Papadimitriou | #latex_show_pagerefs = False
|
229 | 872ca586 | Kostas Papadimitriou | |
230 | 872ca586 | Kostas Papadimitriou | # If true, show URL addresses after external links.
|
231 | 872ca586 | Kostas Papadimitriou | #latex_show_urls = False
|
232 | 872ca586 | Kostas Papadimitriou | |
233 | 872ca586 | Kostas Papadimitriou | # Additional stuff for the LaTeX preamble.
|
234 | 872ca586 | Kostas Papadimitriou | #latex_preamble = ''
|
235 | 872ca586 | Kostas Papadimitriou | |
236 | 872ca586 | Kostas Papadimitriou | # Documents to append as an appendix to all manuals.
|
237 | 872ca586 | Kostas Papadimitriou | #latex_appendices = []
|
238 | 872ca586 | Kostas Papadimitriou | |
239 | 872ca586 | Kostas Papadimitriou | # If false, no module index is generated.
|
240 | 872ca586 | Kostas Papadimitriou | #latex_domain_indices = True
|
241 | 872ca586 | Kostas Papadimitriou | |
242 | 872ca586 | Kostas Papadimitriou | |
243 | 872ca586 | Kostas Papadimitriou | # -- Options for manual page output --------------------------------------------
|
244 | 872ca586 | Kostas Papadimitriou | |
245 | 872ca586 | Kostas Papadimitriou | # One entry per manual page. List of tuples
|
246 | 872ca586 | Kostas Papadimitriou | # (source start file, name, description, authors, manual section).
|
247 | 872ca586 | Kostas Papadimitriou | man_pages = [ |
248 | 872ca586 | Kostas Papadimitriou | ('index', 'snf-cloudcms', u'snf-cloudcms Documentation', |
249 | 872ca586 | Kostas Papadimitriou | [u'GRNET'], 1) |
250 | 872ca586 | Kostas Papadimitriou | ] |
251 | 872ca586 | Kostas Papadimitriou | |
252 | 872ca586 | Kostas Papadimitriou | |
253 | 872ca586 | Kostas Papadimitriou | # Example configuration for intersphinx: refer to the Python standard library.
|
254 | 872ca586 | Kostas Papadimitriou | intersphinx_mapping = {'http://docs.python.org/': None} |