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