1
|
|
|
# -*- coding: utf-8 -*- |
2
|
|
|
# |
3
|
|
|
# Elodie documentation build configuration file, created by |
4
|
|
|
# sphinx-quickstart on Fri Jan 8 14:42:49 2016. |
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 os |
16
|
|
|
import shlex |
17
|
|
|
import sys |
18
|
|
|
|
19
|
|
|
import mock |
20
|
|
|
|
21
|
|
|
# Add the parent folder to the Python path so Sphinx can import elodie modules. |
22
|
|
|
sys.path.insert(0, os.path.abspath('..')) |
23
|
|
|
|
24
|
|
|
# Mock out the pyexiv2 module so we don't have to install it when we build |
25
|
|
|
# docs on ReadTheDocs. |
26
|
|
|
sys.modules['pyexiv2'] = mock.Mock() |
27
|
|
|
|
28
|
|
|
|
29
|
|
|
# -- General configuration ------------------------------------------------ |
30
|
|
|
|
31
|
|
|
# If your documentation needs a minimal Sphinx version, state it here. |
32
|
|
|
#needs_sphinx = '1.0' |
33
|
|
|
|
34
|
|
|
# Add any Sphinx extension module names here, as strings. They can be |
35
|
|
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
36
|
|
|
# ones. |
37
|
|
|
extensions = [ |
38
|
|
|
'sphinx.ext.autodoc', |
39
|
|
|
] |
40
|
|
|
|
41
|
|
|
# Add any paths that contain templates here, relative to this directory. |
42
|
|
|
templates_path = ['_templates'] |
43
|
|
|
|
44
|
|
|
# The suffix(es) of source filenames. |
45
|
|
|
# You can specify multiple suffix as a list of string: |
46
|
|
|
# source_suffix = ['.rst', '.md'] |
47
|
|
|
source_suffix = '.rst' |
48
|
|
|
|
49
|
|
|
# The encoding of source files. |
50
|
|
|
#source_encoding = 'utf-8-sig' |
51
|
|
|
|
52
|
|
|
# The master toctree document. |
53
|
|
|
master_doc = 'index' |
54
|
|
|
|
55
|
|
|
# General information about the project. |
56
|
|
|
project = u'Elodie' |
57
|
|
|
copyright = u'2016, Jaisen Mathai' |
58
|
|
|
author = u'Jaisen Mathai' |
59
|
|
|
|
60
|
|
|
# The version info for the project you're documenting, acts as replacement for |
61
|
|
|
# |version| and |release|, also used in various other places throughout the |
62
|
|
|
# built documents. |
63
|
|
|
# |
64
|
|
|
# The short X.Y version. |
65
|
|
|
version = u'0.1.0' |
66
|
|
|
# The full version, including alpha/beta/rc tags. |
67
|
|
|
release = u'0.1.0' |
68
|
|
|
|
69
|
|
|
# The language for content autogenerated by Sphinx. Refer to documentation |
70
|
|
|
# for a list of supported languages. |
71
|
|
|
# |
72
|
|
|
# This is also used if you do content translation via gettext catalogs. |
73
|
|
|
# Usually you set "language" from the command line for these cases. |
74
|
|
|
language = None |
75
|
|
|
|
76
|
|
|
# There are two options for replacing |today|: either, you set today to some |
77
|
|
|
# non-false value, then it is used: |
78
|
|
|
#today = '' |
79
|
|
|
# Else, today_fmt is used as the format for a strftime call. |
80
|
|
|
#today_fmt = '%B %d, %Y' |
81
|
|
|
|
82
|
|
|
# List of patterns, relative to source directory, that match files and |
83
|
|
|
# directories to ignore when looking for source files. |
84
|
|
|
exclude_patterns = ['_build'] |
85
|
|
|
|
86
|
|
|
# The reST default role (used for this markup: `text`) to use for all |
87
|
|
|
# documents. |
88
|
|
|
#default_role = None |
89
|
|
|
|
90
|
|
|
# If true, '()' will be appended to :func: etc. cross-reference text. |
91
|
|
|
#add_function_parentheses = True |
92
|
|
|
|
93
|
|
|
# If true, the current module name will be prepended to all description |
94
|
|
|
# unit titles (such as .. function::). |
95
|
|
|
#add_module_names = True |
96
|
|
|
|
97
|
|
|
# If true, sectionauthor and moduleauthor directives will be shown in the |
98
|
|
|
# output. They are ignored by default. |
99
|
|
|
#show_authors = False |
100
|
|
|
|
101
|
|
|
# The name of the Pygments (syntax highlighting) style to use. |
102
|
|
|
pygments_style = 'sphinx' |
103
|
|
|
|
104
|
|
|
# A list of ignored prefixes for module index sorting. |
105
|
|
|
#modindex_common_prefix = [] |
106
|
|
|
|
107
|
|
|
# If true, keep warnings as "system message" paragraphs in the built documents. |
108
|
|
|
#keep_warnings = False |
109
|
|
|
|
110
|
|
|
# If true, `todo` and `todoList` produce output, else they produce nothing. |
111
|
|
|
todo_include_todos = False |
112
|
|
|
|
113
|
|
|
|
114
|
|
|
# -- Options for HTML output ---------------------------------------------- |
115
|
|
|
|
116
|
|
|
# The theme to use for HTML and HTML Help pages. See the documentation for |
117
|
|
|
# a list of builtin themes. |
118
|
|
|
# html_theme = 'alabaster' |
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
|
|
|
# Add any extra paths that contain custom files (such as robots.txt or |
150
|
|
|
# .htaccess) here, relative to this directory. These files are copied |
151
|
|
|
# directly to the root of the documentation. |
152
|
|
|
#html_extra_path = [] |
153
|
|
|
|
154
|
|
|
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
155
|
|
|
# using the given strftime format. |
156
|
|
|
#html_last_updated_fmt = '%b %d, %Y' |
157
|
|
|
|
158
|
|
|
# If true, SmartyPants will be used to convert quotes and dashes to |
159
|
|
|
# typographically correct entities. |
160
|
|
|
#html_use_smartypants = True |
161
|
|
|
|
162
|
|
|
# Custom sidebar templates, maps document names to template names. |
163
|
|
|
#html_sidebars = {} |
164
|
|
|
|
165
|
|
|
# Additional templates that should be rendered to pages, maps page names to |
166
|
|
|
# template names. |
167
|
|
|
#html_additional_pages = {} |
168
|
|
|
|
169
|
|
|
# If false, no module index is generated. |
170
|
|
|
#html_domain_indices = True |
171
|
|
|
|
172
|
|
|
# If false, no index is generated. |
173
|
|
|
#html_use_index = True |
174
|
|
|
|
175
|
|
|
# If true, the index is split into individual pages for each letter. |
176
|
|
|
#html_split_index = False |
177
|
|
|
|
178
|
|
|
# If true, links to the reST sources are added to the pages. |
179
|
|
|
#html_show_sourcelink = True |
180
|
|
|
|
181
|
|
|
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. |
182
|
|
|
#html_show_sphinx = True |
183
|
|
|
|
184
|
|
|
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. |
185
|
|
|
#html_show_copyright = True |
186
|
|
|
|
187
|
|
|
# If true, an OpenSearch description file will be output, and all pages will |
188
|
|
|
# contain a <link> tag referring to it. The value of this option must be the |
189
|
|
|
# base URL from which the finished HTML is served. |
190
|
|
|
#html_use_opensearch = '' |
191
|
|
|
|
192
|
|
|
# This is the file name suffix for HTML files (e.g. ".xhtml"). |
193
|
|
|
#html_file_suffix = None |
194
|
|
|
|
195
|
|
|
# Language to be used for generating the HTML full-text search index. |
196
|
|
|
# Sphinx supports the following languages: |
197
|
|
|
# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' |
198
|
|
|
# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' |
199
|
|
|
#html_search_language = 'en' |
200
|
|
|
|
201
|
|
|
# A dictionary with options for the search language support, empty by default. |
202
|
|
|
# Now only 'ja' uses this config value |
203
|
|
|
#html_search_options = {'type': 'default'} |
204
|
|
|
|
205
|
|
|
# The name of a javascript file (relative to the configuration directory) that |
206
|
|
|
# implements a search results scorer. If empty, the default will be used. |
207
|
|
|
#html_search_scorer = 'scorer.js' |
208
|
|
|
|
209
|
|
|
# Output file base name for HTML help builder. |
210
|
|
|
htmlhelp_basename = 'Elodiedoc' |
211
|
|
|
|
212
|
|
|
# -- Options for LaTeX output --------------------------------------------- |
213
|
|
|
|
214
|
|
|
latex_elements = { |
215
|
|
|
# The paper size ('letterpaper' or 'a4paper'). |
216
|
|
|
#'papersize': 'letterpaper', |
217
|
|
|
|
218
|
|
|
# The font size ('10pt', '11pt' or '12pt'). |
219
|
|
|
#'pointsize': '10pt', |
220
|
|
|
|
221
|
|
|
# Additional stuff for the LaTeX preamble. |
222
|
|
|
#'preamble': '', |
223
|
|
|
|
224
|
|
|
# Latex figure (float) alignment |
225
|
|
|
#'figure_align': 'htbp', |
226
|
|
|
} |
227
|
|
|
|
228
|
|
|
# Grouping the document tree into LaTeX files. List of tuples |
229
|
|
|
# (source start file, target name, title, |
230
|
|
|
# author, documentclass [howto, manual, or own class]). |
231
|
|
|
latex_documents = [ |
232
|
|
|
(master_doc, 'Elodie.tex', u'Elodie Documentation', |
233
|
|
|
u'Jaisen Mathai', 'manual'), |
234
|
|
|
] |
235
|
|
|
|
236
|
|
|
# The name of an image file (relative to this directory) to place at the top of |
237
|
|
|
# the title page. |
238
|
|
|
#latex_logo = None |
239
|
|
|
|
240
|
|
|
# For "manual" documents, if this is true, then toplevel headings are parts, |
241
|
|
|
# not chapters. |
242
|
|
|
#latex_use_parts = False |
243
|
|
|
|
244
|
|
|
# If true, show page references after internal links. |
245
|
|
|
#latex_show_pagerefs = False |
246
|
|
|
|
247
|
|
|
# If true, show URL addresses after external links. |
248
|
|
|
#latex_show_urls = False |
249
|
|
|
|
250
|
|
|
# Documents to append as an appendix to all manuals. |
251
|
|
|
#latex_appendices = [] |
252
|
|
|
|
253
|
|
|
# If false, no module index is generated. |
254
|
|
|
#latex_domain_indices = True |
255
|
|
|
|
256
|
|
|
|
257
|
|
|
# -- Options for manual page output --------------------------------------- |
258
|
|
|
|
259
|
|
|
# One entry per manual page. List of tuples |
260
|
|
|
# (source start file, name, description, authors, manual section). |
261
|
|
|
man_pages = [ |
262
|
|
|
(master_doc, 'elodie', u'Elodie Documentation', |
263
|
|
|
[author], 1) |
264
|
|
|
] |
265
|
|
|
|
266
|
|
|
# If true, show URL addresses after external links. |
267
|
|
|
#man_show_urls = False |
268
|
|
|
|
269
|
|
|
|
270
|
|
|
# -- Options for Texinfo output ------------------------------------------- |
271
|
|
|
|
272
|
|
|
# Grouping the document tree into Texinfo files. List of tuples |
273
|
|
|
# (source start file, target name, title, author, |
274
|
|
|
# dir menu entry, description, category) |
275
|
|
|
texinfo_documents = [ |
276
|
|
|
(master_doc, 'Elodie', u'Elodie Documentation', |
277
|
|
|
author, 'Elodie', 'One line description of project.', |
278
|
|
|
'Miscellaneous'), |
279
|
|
|
] |
280
|
|
|
|
281
|
|
|
# Documents to append as an appendix to all manuals. |
282
|
|
|
#texinfo_appendices = [] |
283
|
|
|
|
284
|
|
|
# If false, no module index is generated. |
285
|
|
|
#texinfo_domain_indices = True |
286
|
|
|
|
287
|
|
|
# How to display URL addresses: 'footnote', 'no', or 'inline'. |
288
|
|
|
#texinfo_show_urls = 'footnote' |
289
|
|
|
|
290
|
|
|
# If true, do not generate a @detailmenu in the "Top" node's menu. |
291
|
|
|
#texinfo_no_detailmenu = False |
292
|
|
|
|