~zsombi/ubuntu-ui-toolkit/colorSelector
» Revision
1376.4.1
: documentation/autopilot-helpers/conf.py
« back to all changes in this revision
Viewing changes to documentation/autopilot-helpers/conf.py
- browse files at revision 1376.4.1
- compare with another revision
- download diff
- download tarball
- view history from revision 1376.4.1
- Committer: nskaggs
- Date: 2015-01-14 15:18:05 UTC
- mto: This revision was merged to the branch mainline in revision 1396.
- Revision ID: nicholas.skaggs@canonical.com-20150114151805-foc8w73hb0nowntb
add autopilot-helpers to build
- files added:
- debian/ubuntu-ui-toolkit-autopilot.docs
- documentation/autopilot-helpers
- documentation/autopilot-helpers/_static
- documentation/autopilot-helpers/_templates
- documentation/autopilot-helpers/images
- files modified:
- README
added
removed
documentation/autopilot-helpers/conf.py
1
# -*- coding: utf-8 -*-
2
#
3
# ubuntu-ui-toolkit-autopilot documentation build configuration file, created by
4
# sphinx-quickstart on Thu Jan 8 12:39:43 2015.
5
#
6
# This file is execfile()d with the current directory set to its
7
# containing 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
30
# ones.
31
extensions = [
32
'sphinx.ext.autodoc',
33
'sphinx.ext.doctest',
34
'sphinx.ext.todo',
35
'sphinx.ext.viewcode',
36
]
37
38
# Add any paths that contain templates here, relative to this directory.
39
templates_path = ['_templates']
40
41
# The suffix of source filenames.
42
source_suffix = '.rst'
43
44
# The encoding of source files.
45
#source_encoding = 'utf-8-sig'
46
47
# The master toctree document.
48
master_doc = 'index'
49
50
# General information about the project.
51
project = u'ubuntu-ui-toolkit-autopilot'
52
copyright = u'2015, Canonical'
53
54
# The version info for the project you're documenting, acts as replacement for
55
# |version| and |release|, also used in various other places throughout the
56
# built documents.
57
#
58
# The short X.Y version.
59
version = '15.04'
60
# The full version, including alpha/beta/rc tags.
61
release = '15.04'
62
63
# The language for content autogenerated by Sphinx. Refer to documentation
64
# for a list of supported languages.
65
#language = None
66
67
# There are two options for replacing |today|: either, you set today to some
68
# non-false value, then it is used:
69
#today = ''
70
# Else, today_fmt is used as the format for a strftime call.
71
#today_fmt = '%B %d, %Y'
72
73
# List of patterns, relative to source directory, that match files and
74
# directories to ignore when looking for source files.
75
exclude_patterns = ['_build']
76
77
# The reST default role (used for this markup: `text`) to use for all
78
# documents.
79
#default_role = None
80
81
# If true, '()' will be appended to :func: etc. cross-reference text.
82
#add_function_parentheses = True
83
84
# If true, the current module name will be prepended to all description
85
# unit titles (such as .. function::).
86
#add_module_names = True
87
88
# If true, sectionauthor and moduleauthor directives will be shown in the
89
# output. They are ignored by default.
90
#show_authors = False
91
92
# The name of the Pygments (syntax highlighting) style to use.
93
pygments_style = 'sphinx'
94
95
# A list of ignored prefixes for module index sorting.
96
#modindex_common_prefix = []
97
98
# If true, keep warnings as "system message" paragraphs in the built documents.
99
#keep_warnings = False
100
101
102
# -- Options for HTML output ----------------------------------------------
103
104
# The theme to use for HTML and HTML Help pages. See the documentation for
105
# a list of builtin themes.
106
html_theme = 'default'
107
108
# Theme options are theme-specific and customize the look and feel of a theme
109
# further. For a list of options available for each theme, see the
110
# documentation.
111
#html_theme_options = {}
112
113
# Add any paths that contain custom themes here, relative to this directory.
114
#html_theme_path = []
115
116
# The name for this set of Sphinx documents. If None, it defaults to
117
# "<project> v<release> documentation".
118
#html_title = None
119
120
# A shorter title for the navigation bar. Default is the same as html_title.
121
#html_short_title = None
122
123
# The name of an image file (relative to this directory) to place at the top
124
# of the sidebar.
125
#html_logo = None
126
127
html_favicon = './images/favicon.ico'
128
129
# Add any paths that contain custom static files (such as style sheets) here,
130
# relative to this directory. They are copied after the builtin static files,
131
# so a file named "default.css" will overwrite the builtin "default.css".
132
html_static_path = ['_static']
133
134
# Add any extra paths that contain custom files (such as robots.txt or
135
# .htaccess) here, relative to this directory. These files are copied
136
# directly to the root of the documentation.
137
#html_extra_path = []
138
139
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
140
# using the given strftime format.
141
#html_last_updated_fmt = '%b %d, %Y'
142
143
# If true, SmartyPants will be used to convert quotes and dashes to
144
# typographically correct entities.
145
#html_use_smartypants = True
146
147
# Custom sidebar templates, maps document names to template names.
148
#html_sidebars = {}
149
150
html_domain_indices = True
151
# Additional templates that should be rendered to pages, maps page names to
152
# template names.
153
html_use_index = True
154
#html_additional_pages = {}
155
156
# If false, no module index is generated.
157
#html_domain_indices = True
158
159
html_show_sourcelink = False
160
# If false, no index is generated.
161
#html_use_index = True
162
html_show_sphinx = False
163
164
# If true, the index is split into individual pages for each letter.
165
html_show_copyright = True
166
#html_split_index = False
167
168
# If true, links to the reST sources are added to the pages.
169
#html_show_sourcelink = True
170
171
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
172
#html_show_sphinx = True
173
174
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
175
#html_show_copyright = True
176
177
# If true, an OpenSearch description file will be output, and all pages will
178
# contain a <link> tag referring to it. The value of this option must be the
179
# base URL from which the finished HTML is served.
180
#html_use_opensearch = ''
181
182
# This is the file name suffix for HTML files (e.g. ".xhtml").
183
#html_file_suffix = None
184
185
# Output file base name for HTML help builder.
186
htmlhelp_basename = 'ubuntu-ui-toolkit-autopilotdoc'
187
188
189
# -- Options for LaTeX output ---------------------------------------------
190
191
latex_elements = {
192
# The paper size ('letterpaper' or 'a4paper').
193
#'papersize': 'letterpaper',
194
195
# The font size ('10pt', '11pt' or '12pt').
196
#'pointsize': '10pt',
197
198
# Additional stuff for the LaTeX preamble.
199
#'preamble': '',
200
}
201
202
# Grouping the document tree into LaTeX files. List of tuples
203
# (source start file, target name, title,
204
# author, documentclass [howto, manual, or own class]).
205
latex_documents = [
206
('index', 'ubuntu-ui-toolkit-autopilot.tex',
207
u'ubuntu-ui-toolkit-autopilot Documentation',
208
u'authors', 'manual'),
209
]
210
211
# The name of an image file (relative to this directory) to place at the top of
212
# the title page.
213
#latex_logo = None
214
215
# For "manual" documents, if this is true, then toplevel headings are parts,
216
# not chapters.
217
#latex_use_parts = False
218
219
# If true, show page references after internal links.
220
#latex_show_pagerefs = False
221
222
# If true, show URL addresses after external links.
223
#latex_show_urls = False
224
225
# Documents to append as an appendix to all manuals.
226
#latex_appendices = []
227
228
# If false, no module index is generated.
229
#latex_domain_indices = True
230
231
232
# -- Options for manual page output ---------------------------------------
233
234
# One entry per manual page. List of tuples
235
# (source start file, name, description, authors, manual section).
236
man_pages = [
237
('index', 'ubuntu-ui-toolkit-autopilot',
238
u'ubuntu-ui-toolkit-autopilot Documentation',
239
[u'authors'], 1)
240
]
241
242
# If true, show URL addresses after external links.
243
#man_show_urls = False
244
245
246
# -- Options for Texinfo output -------------------------------------------
247
248
# Grouping the document tree into Texinfo files. List of tuples
249
# (source start file, target name, title, author,
250
# dir menu entry, description, category)
251
texinfo_documents = [
252
('index', 'ubuntu-ui-toolkit-autopilot',
253
u'ubuntu-ui-toolkit-autopilot Documentation',
254
u'authors', 'ubuntu-ui-toolkit-autopilot',
255
'An autopilot emulator for the ubuntu sdk',
256
'Miscellaneous'),
257
]
258
259
# Documents to append as an appendix to all manuals.
260
#texinfo_appendices = []
261
262
# If false, no module index is generated.
263
#texinfo_domain_indices = True
264
265
# How to display URL addresses: 'footnote', 'no', or 'inline'.
266
#texinfo_show_urls = 'footnote'
267
268
# If true, do not generate a @detailmenu in the "Top" node's menu.
269
#texinfo_no_detailmenu = False
270
271
272
# -- Options for Epub output ----------------------------------------------
273
274
# Bibliographic Dublin Core info.
275
epub_title = u'ubuntu-ui-toolkit-autopilot'
276
epub_author = u'authors'
277
epub_publisher = u'Canonical'
278
epub_copyright = u'2015, Canonical'
279
280
# The basename for the epub file. It defaults to the project name.
281
#epub_basename = u'ubuntu-ui-toolkit-autopilot'
282
283
# The HTML theme for the epub output. Since the default themes are not optimized
284
# for small screen space, using the same theme for HTML and epub output is
285
# usually not wise. This defaults to 'epub', a theme designed to save visual
286
# space.
287
#epub_theme = 'epub'
288
289
# The language of the text. It defaults to the language option
290
# or en if the language is not set.
291
#epub_language = ''
292
293
# The scheme of the identifier. Typical schemes are ISBN or URL.
294
#epub_scheme = ''
295
296
# The unique identifier of the text. This can be a ISBN number
297
# or the project homepage.
298
#epub_identifier = ''
299
300
# A unique identification for the text.
301
#epub_uid = ''
302
303
# A tuple containing the cover image and cover page html template filenames.
304
#epub_cover = ()
305
306
# A sequence of (type, uri, title) tuples for the guide element of content.opf.
307
#epub_guide = ()
308
309
# HTML files that should be inserted before the pages created by sphinx.
310
# The format is a list of tuples containing the path and title.
311
#epub_pre_files = []
312
313
# HTML files shat should be inserted after the pages created by sphinx.
314
# The format is a list of tuples containing the path and title.
315
#epub_post_files = []
316
317
# A list of files that should not be packed into the epub file.
318
epub_exclude_files = ['search.html']
319
320
# The depth of the table of contents in toc.ncx.
321
#epub_tocdepth = 3
322
323
# Allow duplicate toc entries.
324
#epub_tocdup = True
325
326
# Choose between 'default' and 'includehidden'.
327
#epub_tocscope = 'default'
328
329
# Fix unsupported image types using the PIL.
330
#epub_fix_images = False
331
332
# Scale large images.
333
#epub_max_image_width = 0
334
335
# How to display URL addresses: 'footnote', 'no', or 'inline'.
336
#epub_show_urls = 'inline'
337
338
# If false, no index is generated.
339
#epub_use_index = True
Loggerhead is a web-based interface for Breezy
Version: 2.0.1