root / docs / conf.py @ 92bfe974
History | View | Annotate | Download (7.9 kB)
1 | 7b006adb | Nikos Skalkotos | # -*- coding: utf-8 -*-
|
---|---|---|---|
2 | 7b006adb | Nikos Skalkotos | #
|
3 | 7b006adb | Nikos Skalkotos | # snf-image-creator documentation build configuration file, created by
|
4 | 7b006adb | Nikos Skalkotos | # sphinx-quickstart on Mon Oct 8 12:34:17 2012.
|
5 | 7b006adb | Nikos Skalkotos | #
|
6 | e982b634 | Nikos Skalkotos | # This file is execfile()d with the current directory set to its containing
|
7 | e982b634 | Nikos Skalkotos | # dir.
|
8 | 7b006adb | Nikos Skalkotos | #
|
9 | 7b006adb | Nikos Skalkotos | # Note that not all possible configuration values are present in this
|
10 | 7b006adb | Nikos Skalkotos | # autogenerated file.
|
11 | 7b006adb | Nikos Skalkotos | #
|
12 | 7b006adb | Nikos Skalkotos | # All configuration values have a default; values that are commented out
|
13 | 7b006adb | Nikos Skalkotos | # serve to show the default.
|
14 | 7b006adb | Nikos Skalkotos | |
15 | e982b634 | Nikos Skalkotos | import sys |
16 | e982b634 | Nikos Skalkotos | import os |
17 | 7b006adb | Nikos Skalkotos | |
18 | 7b006adb | Nikos Skalkotos | # If extensions (or modules to document with autodoc) are in another directory,
|
19 | 7b006adb | Nikos Skalkotos | # add these directories to sys.path here. If the directory is relative to the
|
20 | 7b006adb | Nikos Skalkotos | # documentation root, use os.path.abspath to make it absolute, like shown here.
|
21 | 7b006adb | Nikos Skalkotos | #sys.path.insert(0, os.path.abspath('.'))
|
22 | 7b006adb | Nikos Skalkotos | |
23 | e982b634 | Nikos Skalkotos | # -- General configuration ----------------------------------------------------
|
24 | 7b006adb | Nikos Skalkotos | |
25 | 7b006adb | Nikos Skalkotos | # If your documentation needs a minimal Sphinx version, state it here.
|
26 | 7b006adb | Nikos Skalkotos | #needs_sphinx = '1.0'
|
27 | 7b006adb | Nikos Skalkotos | |
28 | e982b634 | Nikos Skalkotos | # Add any Sphinx extension module names here, as strings. They can be
|
29 | e982b634 | Nikos Skalkotos | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
30 | 7b006adb | Nikos Skalkotos | extensions = [] |
31 | 7b006adb | Nikos Skalkotos | |
32 | 7b006adb | Nikos Skalkotos | # Add any paths that contain templates here, relative to this directory.
|
33 | 7b006adb | Nikos Skalkotos | templates_path = ['_templates']
|
34 | 7b006adb | Nikos Skalkotos | |
35 | 7b006adb | Nikos Skalkotos | # The suffix of source filenames.
|
36 | 7b006adb | Nikos Skalkotos | source_suffix = '.rst'
|
37 | 7b006adb | Nikos Skalkotos | |
38 | 7b006adb | Nikos Skalkotos | # The encoding of source files.
|
39 | 7b006adb | Nikos Skalkotos | #source_encoding = 'utf-8-sig'
|
40 | 7b006adb | Nikos Skalkotos | |
41 | 7b006adb | Nikos Skalkotos | # The master toctree document.
|
42 | 7b006adb | Nikos Skalkotos | master_doc = 'index'
|
43 | 7b006adb | Nikos Skalkotos | |
44 | 7b006adb | Nikos Skalkotos | # General information about the project.
|
45 | 7b006adb | Nikos Skalkotos | project = u'snf-image-creator'
|
46 | 18f71e1e | Nikos Skalkotos | copyright = u'2012, 2013 GRNET S.A. All rights reserved'
|
47 | 7b006adb | Nikos Skalkotos | |
48 | 7b006adb | Nikos Skalkotos | # The version info for the project you're documenting, acts as replacement for
|
49 | 7b006adb | Nikos Skalkotos | # |version| and |release|, also used in various other places throughout the
|
50 | 7b006adb | Nikos Skalkotos | # built documents.
|
51 | 7b006adb | Nikos Skalkotos | #
|
52 | 7b006adb | Nikos Skalkotos | # The short X.Y version.
|
53 | 92bfe974 | Nikos Skalkotos | version = '0.2.5'
|
54 | 7b006adb | Nikos Skalkotos | # The full version, including alpha/beta/rc tags.
|
55 | 92bfe974 | Nikos Skalkotos | release = '0.2.5'
|
56 | 7b006adb | Nikos Skalkotos | |
57 | 7b006adb | Nikos Skalkotos | # The language for content autogenerated by Sphinx. Refer to documentation
|
58 | 7b006adb | Nikos Skalkotos | # for a list of supported languages.
|
59 | 7b006adb | Nikos Skalkotos | #language = None
|
60 | 7b006adb | Nikos Skalkotos | |
61 | 7b006adb | Nikos Skalkotos | # There are two options for replacing |today|: either, you set today to some
|
62 | 7b006adb | Nikos Skalkotos | # non-false value, then it is used:
|
63 | 7b006adb | Nikos Skalkotos | #today = ''
|
64 | 7b006adb | Nikos Skalkotos | # Else, today_fmt is used as the format for a strftime call.
|
65 | 7b006adb | Nikos Skalkotos | #today_fmt = '%B %d, %Y'
|
66 | 7b006adb | Nikos Skalkotos | |
67 | 7b006adb | Nikos Skalkotos | # List of patterns, relative to source directory, that match files and
|
68 | 7b006adb | Nikos Skalkotos | # directories to ignore when looking for source files.
|
69 | 7b006adb | Nikos Skalkotos | exclude_patterns = ['_build']
|
70 | 7b006adb | Nikos Skalkotos | |
71 | e982b634 | Nikos Skalkotos | # The reST default role (used for this markup: `text`) to use for all
|
72 | e982b634 | Nikos Skalkotos | # documents.
|
73 | 7b006adb | Nikos Skalkotos | #default_role = None
|
74 | 7b006adb | Nikos Skalkotos | |
75 | 7b006adb | Nikos Skalkotos | # If true, '()' will be appended to :func: etc. cross-reference text.
|
76 | 7b006adb | Nikos Skalkotos | #add_function_parentheses = True
|
77 | 7b006adb | Nikos Skalkotos | |
78 | 7b006adb | Nikos Skalkotos | # If true, the current module name will be prepended to all description
|
79 | 7b006adb | Nikos Skalkotos | # unit titles (such as .. function::).
|
80 | 7b006adb | Nikos Skalkotos | #add_module_names = True
|
81 | 7b006adb | Nikos Skalkotos | |
82 | 7b006adb | Nikos Skalkotos | # If true, sectionauthor and moduleauthor directives will be shown in the
|
83 | 7b006adb | Nikos Skalkotos | # output. They are ignored by default.
|
84 | 7b006adb | Nikos Skalkotos | #show_authors = False
|
85 | 7b006adb | Nikos Skalkotos | |
86 | 7b006adb | Nikos Skalkotos | # The name of the Pygments (syntax highlighting) style to use.
|
87 | 7b006adb | Nikos Skalkotos | pygments_style = 'sphinx'
|
88 | 7b006adb | Nikos Skalkotos | |
89 | 7b006adb | Nikos Skalkotos | # A list of ignored prefixes for module index sorting.
|
90 | 7b006adb | Nikos Skalkotos | #modindex_common_prefix = []
|
91 | 7b006adb | Nikos Skalkotos | |
92 | 7b006adb | Nikos Skalkotos | |
93 | e982b634 | Nikos Skalkotos | # -- Options for HTML output --------------------------------------------------
|
94 | 7b006adb | Nikos Skalkotos | |
95 | 7b006adb | Nikos Skalkotos | # The theme to use for HTML and HTML Help pages. See the documentation for
|
96 | 7b006adb | Nikos Skalkotos | # a list of builtin themes.
|
97 | 7b006adb | Nikos Skalkotos | html_theme = 'default'
|
98 | 7b006adb | Nikos Skalkotos | |
99 | 7b006adb | Nikos Skalkotos | # Theme options are theme-specific and customize the look and feel of a theme
|
100 | 7b006adb | Nikos Skalkotos | # further. For a list of options available for each theme, see the
|
101 | 7b006adb | Nikos Skalkotos | # documentation.
|
102 | 7b006adb | Nikos Skalkotos | #html_theme_options = {}
|
103 | 7b006adb | Nikos Skalkotos | |
104 | 7b006adb | Nikos Skalkotos | # Add any paths that contain custom themes here, relative to this directory.
|
105 | 7b006adb | Nikos Skalkotos | #html_theme_path = []
|
106 | 7b006adb | Nikos Skalkotos | |
107 | 7b006adb | Nikos Skalkotos | # The name for this set of Sphinx documents. If None, it defaults to
|
108 | 7b006adb | Nikos Skalkotos | # "<project> v<release> documentation".
|
109 | 7b006adb | Nikos Skalkotos | #html_title = None
|
110 | 7b006adb | Nikos Skalkotos | |
111 | 7b006adb | Nikos Skalkotos | # A shorter title for the navigation bar. Default is the same as html_title.
|
112 | 7b006adb | Nikos Skalkotos | #html_short_title = None
|
113 | 7b006adb | Nikos Skalkotos | |
114 | 7b006adb | Nikos Skalkotos | # The name of an image file (relative to this directory) to place at the top
|
115 | 7b006adb | Nikos Skalkotos | # of the sidebar.
|
116 | 7b006adb | Nikos Skalkotos | #html_logo = None
|
117 | 7b006adb | Nikos Skalkotos | |
118 | 7b006adb | Nikos Skalkotos | # The name of an image file (within the static path) to use as favicon of the
|
119 | 7b006adb | Nikos Skalkotos | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
120 | 7b006adb | Nikos Skalkotos | # pixels large.
|
121 | 7b006adb | Nikos Skalkotos | #html_favicon = None
|
122 | 7b006adb | Nikos Skalkotos | |
123 | 7b006adb | Nikos Skalkotos | # Add any paths that contain custom static files (such as style sheets) here,
|
124 | 7b006adb | Nikos Skalkotos | # relative to this directory. They are copied after the builtin static files,
|
125 | 7b006adb | Nikos Skalkotos | # so a file named "default.css" will overwrite the builtin "default.css".
|
126 | 7b006adb | Nikos Skalkotos | html_static_path = ['_static']
|
127 | 7b006adb | Nikos Skalkotos | |
128 | 7b006adb | Nikos Skalkotos | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
129 | 7b006adb | Nikos Skalkotos | # using the given strftime format.
|
130 | 7b006adb | Nikos Skalkotos | #html_last_updated_fmt = '%b %d, %Y'
|
131 | 7b006adb | Nikos Skalkotos | |
132 | 7b006adb | Nikos Skalkotos | # If true, SmartyPants will be used to convert quotes and dashes to
|
133 | 7b006adb | Nikos Skalkotos | # typographically correct entities.
|
134 | 7b006adb | Nikos Skalkotos | #html_use_smartypants = True
|
135 | 7b006adb | Nikos Skalkotos | |
136 | 7b006adb | Nikos Skalkotos | # Custom sidebar templates, maps document names to template names.
|
137 | 7b006adb | Nikos Skalkotos | #html_sidebars = {}
|
138 | 7b006adb | Nikos Skalkotos | |
139 | 7b006adb | Nikos Skalkotos | # Additional templates that should be rendered to pages, maps page names to
|
140 | 7b006adb | Nikos Skalkotos | # template names.
|
141 | 7b006adb | Nikos Skalkotos | #html_additional_pages = {}
|
142 | 7b006adb | Nikos Skalkotos | |
143 | 7b006adb | Nikos Skalkotos | # If false, no module index is generated.
|
144 | 7b006adb | Nikos Skalkotos | #html_domain_indices = True
|
145 | 7b006adb | Nikos Skalkotos | |
146 | 7b006adb | Nikos Skalkotos | # If false, no index is generated.
|
147 | 7b006adb | Nikos Skalkotos | #html_use_index = True
|
148 | 7b006adb | Nikos Skalkotos | |
149 | 7b006adb | Nikos Skalkotos | # If true, the index is split into individual pages for each letter.
|
150 | 7b006adb | Nikos Skalkotos | #html_split_index = False
|
151 | 7b006adb | Nikos Skalkotos | |
152 | 7b006adb | Nikos Skalkotos | # If true, links to the reST sources are added to the pages.
|
153 | 7b006adb | Nikos Skalkotos | #html_show_sourcelink = True
|
154 | 7b006adb | Nikos Skalkotos | |
155 | 7b006adb | Nikos Skalkotos | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
156 | 7b006adb | Nikos Skalkotos | #html_show_sphinx = True
|
157 | 7b006adb | Nikos Skalkotos | |
158 | 7b006adb | Nikos Skalkotos | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
159 | 7b006adb | Nikos Skalkotos | #html_show_copyright = True
|
160 | 7b006adb | Nikos Skalkotos | |
161 | 7b006adb | Nikos Skalkotos | # If true, an OpenSearch description file will be output, and all pages will
|
162 | 7b006adb | Nikos Skalkotos | # contain a <link> tag referring to it. The value of this option must be the
|
163 | 7b006adb | Nikos Skalkotos | # base URL from which the finished HTML is served.
|
164 | 7b006adb | Nikos Skalkotos | #html_use_opensearch = ''
|
165 | 7b006adb | Nikos Skalkotos | |
166 | 7b006adb | Nikos Skalkotos | # This is the file name suffix for HTML files (e.g. ".xhtml").
|
167 | 7b006adb | Nikos Skalkotos | #html_file_suffix = None
|
168 | 7b006adb | Nikos Skalkotos | |
169 | 7b006adb | Nikos Skalkotos | # Output file base name for HTML help builder.
|
170 | 7b006adb | Nikos Skalkotos | htmlhelp_basename = 'snf-image-creatordoc'
|
171 | 7b006adb | Nikos Skalkotos | |
172 | 7b006adb | Nikos Skalkotos | |
173 | e982b634 | Nikos Skalkotos | # -- Options for LaTeX output -------------------------------------------------
|
174 | 7b006adb | Nikos Skalkotos | |
175 | 7b006adb | Nikos Skalkotos | latex_elements = { |
176 | 7b006adb | Nikos Skalkotos | # The paper size ('letterpaper' or 'a4paper').
|
177 | 7b006adb | Nikos Skalkotos | #'papersize': 'letterpaper',
|
178 | 7b006adb | Nikos Skalkotos | |
179 | 7b006adb | Nikos Skalkotos | # The font size ('10pt', '11pt' or '12pt').
|
180 | 7b006adb | Nikos Skalkotos | #'pointsize': '10pt',
|
181 | 7b006adb | Nikos Skalkotos | |
182 | 7b006adb | Nikos Skalkotos | # Additional stuff for the LaTeX preamble.
|
183 | 7b006adb | Nikos Skalkotos | #'preamble': '',
|
184 | 7b006adb | Nikos Skalkotos | } |
185 | 7b006adb | Nikos Skalkotos | |
186 | 7b006adb | Nikos Skalkotos | # Grouping the document tree into LaTeX files. List of tuples
|
187 | e982b634 | Nikos Skalkotos | # (source start file, target name, title, author, documentclass
|
188 | e982b634 | Nikos Skalkotos | # [howto/manual]).
|
189 | 7b006adb | Nikos Skalkotos | latex_documents = [ |
190 | 7b006adb | Nikos Skalkotos | ('index', 'snf-image-creator.tex', u'snf-image-creator Documentation', |
191 | 7b006adb | Nikos Skalkotos | u'GRNET', 'manual'), |
192 | 7b006adb | Nikos Skalkotos | ] |
193 | 7b006adb | Nikos Skalkotos | |
194 | 7b006adb | Nikos Skalkotos | # The name of an image file (relative to this directory) to place at the top of
|
195 | 7b006adb | Nikos Skalkotos | # the title page.
|
196 | 7b006adb | Nikos Skalkotos | #latex_logo = None
|
197 | 7b006adb | Nikos Skalkotos | |
198 | 7b006adb | Nikos Skalkotos | # For "manual" documents, if this is true, then toplevel headings are parts,
|
199 | 7b006adb | Nikos Skalkotos | # not chapters.
|
200 | 7b006adb | Nikos Skalkotos | #latex_use_parts = False
|
201 | 7b006adb | Nikos Skalkotos | |
202 | 7b006adb | Nikos Skalkotos | # If true, show page references after internal links.
|
203 | 7b006adb | Nikos Skalkotos | #latex_show_pagerefs = False
|
204 | 7b006adb | Nikos Skalkotos | |
205 | 7b006adb | Nikos Skalkotos | # If true, show URL addresses after external links.
|
206 | 7b006adb | Nikos Skalkotos | #latex_show_urls = False
|
207 | 7b006adb | Nikos Skalkotos | |
208 | 7b006adb | Nikos Skalkotos | # Documents to append as an appendix to all manuals.
|
209 | 7b006adb | Nikos Skalkotos | #latex_appendices = []
|
210 | 7b006adb | Nikos Skalkotos | |
211 | 7b006adb | Nikos Skalkotos | # If false, no module index is generated.
|
212 | 7b006adb | Nikos Skalkotos | #latex_domain_indices = True
|
213 | 7b006adb | Nikos Skalkotos | |
214 | 7b006adb | Nikos Skalkotos | |
215 | e982b634 | Nikos Skalkotos | # -- Options for manual page output -------------------------------------------
|
216 | 7b006adb | Nikos Skalkotos | |
217 | 7b006adb | Nikos Skalkotos | # One entry per manual page. List of tuples
|
218 | 7b006adb | Nikos Skalkotos | # (source start file, name, description, authors, manual section).
|
219 | 7b006adb | Nikos Skalkotos | man_pages = [ |
220 | 18f71e1e | Nikos Skalkotos | ('man/snf-image-creator', 'snf-image-creator', |
221 | 18f71e1e | Nikos Skalkotos | 'Command line image creator for Synnefo',
|
222 | 18f71e1e | Nikos Skalkotos | 'GRNET Development Team <synnefo-devel@googlegroups.com>', 1), |
223 | 18f71e1e | Nikos Skalkotos | ('man/snf-mkimage', 'snf-mkimage', |
224 | 18f71e1e | Nikos Skalkotos | 'Dialog-based image creator for Synnefo',
|
225 | 18f71e1e | Nikos Skalkotos | 'GRNET Development Team <synnefo-devel@googlegroups.com>', 1) |
226 | 7b006adb | Nikos Skalkotos | ] |
227 | 7b006adb | Nikos Skalkotos | |
228 | 7b006adb | Nikos Skalkotos | # If true, show URL addresses after external links.
|
229 | 7b006adb | Nikos Skalkotos | #man_show_urls = False
|
230 | 7b006adb | Nikos Skalkotos | |
231 | 7b006adb | Nikos Skalkotos | |
232 | e982b634 | Nikos Skalkotos | # -- Options for Texinfo output -----------------------------------------------
|
233 | 7b006adb | Nikos Skalkotos | |
234 | 7b006adb | Nikos Skalkotos | # Grouping the document tree into Texinfo files. List of tuples
|
235 | 7b006adb | Nikos Skalkotos | # (source start file, target name, title, author,
|
236 | 7b006adb | Nikos Skalkotos | # dir menu entry, description, category)
|
237 | 7b006adb | Nikos Skalkotos | texinfo_documents = [ |
238 | 7b006adb | Nikos Skalkotos | ('index', 'snf-image-creator', u'snf-image-creator Documentation', |
239 | 7b006adb | Nikos Skalkotos | u'GRNET', 'snf-image-creator', 'One line description of project.', |
240 | 7b006adb | Nikos Skalkotos | 'Miscellaneous'),
|
241 | 7b006adb | Nikos Skalkotos | ] |
242 | 7b006adb | Nikos Skalkotos | |
243 | 7b006adb | Nikos Skalkotos | # Documents to append as an appendix to all manuals.
|
244 | 7b006adb | Nikos Skalkotos | #texinfo_appendices = []
|
245 | 7b006adb | Nikos Skalkotos | |
246 | 7b006adb | Nikos Skalkotos | # If false, no module index is generated.
|
247 | 7b006adb | Nikos Skalkotos | #texinfo_domain_indices = True
|
248 | 7b006adb | Nikos Skalkotos | |
249 | 7b006adb | Nikos Skalkotos | # How to display URL addresses: 'footnote', 'no', or 'inline'.
|
250 | 7b006adb | Nikos Skalkotos | #texinfo_show_urls = 'footnote' |