Statistics
| Branch: | Tag: | Revision:

root / docs / conf.py @ fd6621a4

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.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_options = {
98
       'collapsiblesidebar': 'true',
99
       'footerbgcolor':    '#55b577',
100
       'footertextcolor':  '#000000',
101
       'sidebarbgcolor':   '#ffffff',
102
       'sidebarbtncolor':  '#f2f2f2',
103
       'sidebartextcolor': '#000000',
104
       'sidebarlinkcolor': '#328e4a',
105
       'relbarbgcolor':    '#55b577',
106
       'relbartextcolor':  '#ffffff',
107
       'relbarlinkcolor':  '#ffffff',
108
       'bgcolor':          '#ffffff',
109
       'textcolor':        '#000000',
110
       'headbgcolor':      '#ffffff',
111
       'headtextcolor':    '#000000',
112
       'headlinkcolor':    '#c60f0f',
113
       'linkcolor':        '#328e4a',
114
       'visitedlinkcolor': '#63409b',
115
       'codebgcolor':      '#eeffcc',
116
       'codetextcolor':    '#333333'
117
}
118

    
119

    
120
# Theme options are theme-specific and customize the look and feel of a theme
121
# further.  For a list of options available for each theme, see the
122
# documentation.
123
#html_theme_options = {}
124

    
125
# Add any paths that contain custom themes here, relative to this directory.
126
#html_theme_path = []
127

    
128
# The name for this set of Sphinx documents.  If None, it defaults to
129
# "<project> v<release> documentation".
130
#html_title = None
131

    
132
# A shorter title for the navigation bar.  Default is the same as html_title.
133
#html_short_title = None
134

    
135
# The name of an image file (relative to this directory) to place at the top
136
# of the sidebar.
137
#html_logo = None
138

    
139
# The name of an image file (within the static path) to use as favicon of the
140
# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
141
# pixels large.
142
#html_favicon = None
143

    
144
# Add any paths that contain custom static files (such as style sheets) here,
145
# relative to this directory. They are copied after the builtin static files,
146
# so a file named "default.css" will overwrite the builtin "default.css".
147
html_static_path = ['_static']
148

    
149
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
150
# using the given strftime format.
151
#html_last_updated_fmt = '%b %d, %Y'
152

    
153
# If true, SmartyPants will be used to convert quotes and dashes to
154
# typographically correct entities.
155
#html_use_smartypants = True
156

    
157
# Custom sidebar templates, maps document names to template names.
158
#html_sidebars = {}
159

    
160
# Additional templates that should be rendered to pages, maps page names to
161
# template names.
162
#html_additional_pages = {}
163

    
164
# If false, no module index is generated.
165
#html_domain_indices = True
166

    
167
# If false, no index is generated.
168
#html_use_index = True
169

    
170
# If true, the index is split into individual pages for each letter.
171
#html_split_index = False
172

    
173
# If true, links to the reST sources are added to the pages.
174
#html_show_sourcelink = True
175

    
176
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
177
#html_show_sphinx = True
178

    
179
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
180
#html_show_copyright = True
181

    
182
# If true, an OpenSearch description file will be output, and all pages will
183
# contain a <link> tag referring to it.  The value of this option must be the
184
# base URL from which the finished HTML is served.
185
#html_use_opensearch = ''
186

    
187
# This is the file name suffix for HTML files (e.g. ".xhtml").
188
#html_file_suffix = None
189

    
190
# Output file base name for HTML help builder.
191
htmlhelp_basename = 'snf-image-creatordoc'
192

    
193

    
194
# -- Options for LaTeX output -------------------------------------------------
195

    
196
latex_elements = {
197
# The paper size ('letterpaper' or 'a4paper').
198
#'papersize': 'letterpaper',
199

    
200
# The font size ('10pt', '11pt' or '12pt').
201
#'pointsize': '10pt',
202

    
203
# Additional stuff for the LaTeX preamble.
204
#'preamble': '',
205
}
206

    
207
# Grouping the document tree into LaTeX files. List of tuples
208
# (source start file, target name, title, author, documentclass
209
# [howto/manual]).
210
latex_documents = [
211
  ('index', 'snf-image-creator.tex', u'snf-image-creator Documentation',
212
   u'GRNET', 'manual'),
213
]
214

    
215
# The name of an image file (relative to this directory) to place at the top of
216
# the title page.
217
#latex_logo = None
218

    
219
# For "manual" documents, if this is true, then toplevel headings are parts,
220
# not chapters.
221
#latex_use_parts = False
222

    
223
# If true, show page references after internal links.
224
#latex_show_pagerefs = False
225

    
226
# If true, show URL addresses after external links.
227
#latex_show_urls = False
228

    
229
# Documents to append as an appendix to all manuals.
230
#latex_appendices = []
231

    
232
# If false, no module index is generated.
233
#latex_domain_indices = True
234

    
235

    
236
# -- Options for manual page output -------------------------------------------
237

    
238
# One entry per manual page. List of tuples
239
# (source start file, name, description, authors, manual section).
240
man_pages = [
241
    ('man/snf-image-creator', 'snf-image-creator',
242
     'Command line image creator for Synnefo',
243
     'GRNET Development Team <synnefo-devel@googlegroups.com>', 1),
244
    ('man/snf-mkimage', 'snf-mkimage',
245
     'Dialog-based image creator for Synnefo',
246
     'GRNET Development Team <synnefo-devel@googlegroups.com>', 1)
247
]
248

    
249
# If true, show URL addresses after external links.
250
#man_show_urls = False
251

    
252

    
253
# -- Options for Texinfo output -----------------------------------------------
254

    
255
# Grouping the document tree into Texinfo files. List of tuples
256
# (source start file, target name, title, author,
257
#  dir menu entry, description, category)
258
texinfo_documents = [
259
  ('index', 'snf-image-creator', u'snf-image-creator Documentation',
260
   u'GRNET', 'snf-image-creator', 'One line description of project.',
261
   'Miscellaneous'),
262
]
263

    
264
# Documents to append as an appendix to all manuals.
265
#texinfo_appendices = []
266

    
267
# If false, no module index is generated.
268
#texinfo_domain_indices = True
269

    
270
# How to display URL addresses: 'footnote', 'no', or 'inline'.
271
#texinfo_show_urls = 'footnote'