root / docs / conf.py @ a8943421
History | View | Annotate | Download (8.6 kB)
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.4.2'
|
54 |
# The full version, including alpha/beta/rc tags.
|
55 |
release = '0.4.2'
|
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 |
'collapsiblesidebar': 'true', |
104 |
'footerbgcolor': '#55b577', |
105 |
'footertextcolor': '#000000', |
106 |
'sidebarbgcolor': '#ffffff', |
107 |
'sidebarbtncolor': '#f2f2f2', |
108 |
'sidebartextcolor': '#000000', |
109 |
'sidebarlinkcolor': '#328e4a', |
110 |
'relbarbgcolor': '#55b577', |
111 |
'relbartextcolor': '#ffffff', |
112 |
'relbarlinkcolor': '#ffffff', |
113 |
'bgcolor': '#ffffff', |
114 |
'textcolor': '#000000', |
115 |
'headbgcolor': '#ffffff', |
116 |
'headtextcolor': '#000000', |
117 |
'headlinkcolor': '#c60f0f', |
118 |
'linkcolor': '#328e4a', |
119 |
'visitedlinkcolor': '#63409b', |
120 |
'codebgcolor': '#eeffcc', |
121 |
'codetextcolor': '#333333' |
122 |
} |
123 |
|
124 |
# Add any paths that contain custom themes here, relative to this directory.
|
125 |
#html_theme_path = []
|
126 |
|
127 |
# The name for this set of Sphinx documents. If None, it defaults to
|
128 |
# "<project> v<release> documentation".
|
129 |
#html_title = None
|
130 |
|
131 |
# A shorter title for the navigation bar. Default is the same as html_title.
|
132 |
#html_short_title = None
|
133 |
|
134 |
# The name of an image file (relative to this directory) to place at the top
|
135 |
# of the sidebar.
|
136 |
#html_logo = None
|
137 |
|
138 |
# The name of an image file (within the static path) to use as favicon of the
|
139 |
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
140 |
# pixels large.
|
141 |
#html_favicon = None
|
142 |
|
143 |
# Add any paths that contain custom static files (such as style sheets) here,
|
144 |
# relative to this directory. They are copied after the builtin static files,
|
145 |
# so a file named "default.css" will overwrite the builtin "default.css".
|
146 |
html_static_path = ['_static']
|
147 |
|
148 |
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
149 |
# using the given strftime format.
|
150 |
#html_last_updated_fmt = '%b %d, %Y'
|
151 |
|
152 |
# If true, SmartyPants will be used to convert quotes and dashes to
|
153 |
# typographically correct entities.
|
154 |
#html_use_smartypants = True
|
155 |
|
156 |
# Custom sidebar templates, maps document names to template names.
|
157 |
#html_sidebars = {}
|
158 |
|
159 |
# Additional templates that should be rendered to pages, maps page names to
|
160 |
# template names.
|
161 |
#html_additional_pages = {}
|
162 |
|
163 |
# If false, no module index is generated.
|
164 |
#html_domain_indices = True
|
165 |
|
166 |
# If false, no index is generated.
|
167 |
#html_use_index = True
|
168 |
|
169 |
# If true, the index is split into individual pages for each letter.
|
170 |
#html_split_index = False
|
171 |
|
172 |
# If true, links to the reST sources are added to the pages.
|
173 |
#html_show_sourcelink = True
|
174 |
|
175 |
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
176 |
#html_show_sphinx = True
|
177 |
|
178 |
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
179 |
#html_show_copyright = True
|
180 |
|
181 |
# If true, an OpenSearch description file will be output, and all pages will
|
182 |
# contain a <link> tag referring to it. The value of this option must be the
|
183 |
# base URL from which the finished HTML is served.
|
184 |
#html_use_opensearch = ''
|
185 |
|
186 |
# This is the file name suffix for HTML files (e.g. ".xhtml").
|
187 |
#html_file_suffix = None
|
188 |
|
189 |
# Output file base name for HTML help builder.
|
190 |
htmlhelp_basename = 'snf-image-creatordoc'
|
191 |
|
192 |
|
193 |
# -- Options for LaTeX output -------------------------------------------------
|
194 |
|
195 |
latex_elements = { |
196 |
# The paper size ('letterpaper' or 'a4paper').
|
197 |
#'papersize': 'letterpaper',
|
198 |
|
199 |
# The font size ('10pt', '11pt' or '12pt').
|
200 |
#'pointsize': '10pt',
|
201 |
|
202 |
# Additional stuff for the LaTeX preamble.
|
203 |
#'preamble': '',
|
204 |
} |
205 |
|
206 |
# Grouping the document tree into LaTeX files. List of tuples
|
207 |
# (source start file, target name, title, author, documentclass
|
208 |
# [howto/manual]).
|
209 |
latex_documents = [ |
210 |
('index', 'snf-image-creator.tex', u'snf-image-creator Documentation', |
211 |
u'GRNET', 'manual'), |
212 |
] |
213 |
|
214 |
# The name of an image file (relative to this directory) to place at the top of
|
215 |
# the title page.
|
216 |
#latex_logo = None
|
217 |
|
218 |
# For "manual" documents, if this is true, then toplevel headings are parts,
|
219 |
# not chapters.
|
220 |
#latex_use_parts = False
|
221 |
|
222 |
# If true, show page references after internal links.
|
223 |
#latex_show_pagerefs = False
|
224 |
|
225 |
# If true, show URL addresses after external links.
|
226 |
#latex_show_urls = False
|
227 |
|
228 |
# Documents to append as an appendix to all manuals.
|
229 |
#latex_appendices = []
|
230 |
|
231 |
# If false, no module index is generated.
|
232 |
#latex_domain_indices = True
|
233 |
|
234 |
|
235 |
# -- Options for manual page output -------------------------------------------
|
236 |
|
237 |
# One entry per manual page. List of tuples
|
238 |
# (source start file, name, description, authors, manual section).
|
239 |
man_pages = [ |
240 |
('man/snf-image-creator', 'snf-image-creator', |
241 |
'Command line image creator for Synnefo',
|
242 |
'Synnefo development team <synnefo-devel@googlegroups.com>', 1), |
243 |
('man/snf-mkimage', 'snf-mkimage', |
244 |
'Dialog-based image creator for Synnefo',
|
245 |
'Synnefo development team <synnefo-devel@googlegroups.com>', 1) |
246 |
] |
247 |
|
248 |
# If true, show URL addresses after external links.
|
249 |
#man_show_urls = False
|
250 |
|
251 |
|
252 |
# -- Options for Texinfo output -----------------------------------------------
|
253 |
|
254 |
# Grouping the document tree into Texinfo files. List of tuples
|
255 |
# (source start file, target name, title, author,
|
256 |
# dir menu entry, description, category)
|
257 |
texinfo_documents = [ |
258 |
('index', 'snf-image-creator', u'snf-image-creator Documentation', |
259 |
u'GRNET', 'snf-image-creator', 'One line description of project.', |
260 |
'Miscellaneous'),
|
261 |
] |
262 |
|
263 |
# Documents to append as an appendix to all manuals.
|
264 |
#texinfo_appendices = []
|
265 |
|
266 |
# If false, no module index is generated.
|
267 |
#texinfo_domain_indices = True
|
268 |
|
269 |
# How to display URL addresses: 'footnote', 'no', or 'inline'.
|
270 |
#texinfo_show_urls = 'footnote'
|