@@ -0,0 +1,358 @@
1+# -*- coding: utf-8 -*-
2+#
3+# searx documentation build configuration file, created by
4+# sphinx-quickstart on Tue Nov 17 17:12:13 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+import shlex
18+
19+# If extensions (or modules to document with autodoc) are in another directory,
20+# add these directories to sys.path here. If the directory is relative to the
21+# documentation root, use os.path.abspath to make it absolute, like shown here.
22+#sys.path.insert(0, os.path.abspath('.'))
23+
24+# -- General configuration ------------------------------------------------
25+
26+# If your documentation needs a minimal Sphinx version, state it here.
27+#needs_sphinx = '1.0'
28+
29+# Add any Sphinx extension module names here, as strings. They can be
30+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
31+# ones.
32+extensions = [
33+ 'sphinx.ext.viewcode',
34+]
35+
36+# Add any paths that contain templates here, relative to this directory.
37+templates_path = ['_templates']
38+
39+# The suffix(es) of source filenames.
40+# You can specify multiple suffix as a list of string:
41+# source_suffix = ['.rst', '.md']
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'searx'
52+copyright = u'2015, Adam Tauber'
53+author = u'Adam Tauber'
54+
55+# The version info for the project you're documenting, acts as replacement for
56+# |version| and |release|, also used in various other places throughout the
57+# built documents.
58+#
59+# The short X.Y version.
60+version = '0.8.0'
61+# The full version, including alpha/beta/rc tags.
62+release = '0.8.0'
63+
64+# The language for content autogenerated by Sphinx. Refer to documentation
65+# for a list of supported languages.
66+#
67+# This is also used if you do content translation via gettext catalogs.
68+# Usually you set "language" from the command line for these cases.
69+language = None
70+
71+# There are two options for replacing |today|: either, you set today to some
72+# non-false value, then it is used:
73+#today = ''
74+# Else, today_fmt is used as the format for a strftime call.
75+#today_fmt = '%B %d, %Y'
76+
77+# List of patterns, relative to source directory, that match files and
78+# directories to ignore when looking for source files.
79+exclude_patterns = []
80+
81+# The reST default role (used for this markup: `text`) to use for all
82+# documents.
83+#default_role = None
84+
85+# If true, '()' will be appended to :func: etc. cross-reference text.
86+#add_function_parentheses = True
87+
88+# If true, the current module name will be prepended to all description
89+# unit titles (such as .. function::).
90+#add_module_names = True
91+
92+# If true, sectionauthor and moduleauthor directives will be shown in the
93+# output. They are ignored by default.
94+#show_authors = False
95+
96+# The name of the Pygments (syntax highlighting) style to use.
97+pygments_style = 'sphinx'
98+
99+# A list of ignored prefixes for module index sorting.
100+#modindex_common_prefix = []
101+
102+# If true, keep warnings as "system message" paragraphs in the built documents.
103+#keep_warnings = False
104+
105+# If true, `todo` and `todoList` produce output, else they produce nothing.
106+todo_include_todos = False
107+
108+
109+# -- Options for HTML output ----------------------------------------------
110+
111+# The theme to use for HTML and HTML Help pages. See the documentation for
112+# a list of builtin themes.
113+sys.path.append(os.path.abspath('_themes'))
114+html_theme_path = ['_themes']
115+html_theme = 'searx_theme'
116+
117+# Theme options are theme-specific and customize the look and feel of a theme
118+# further. For a list of options available for each theme, see the
119+# documentation.
120+#html_theme_options = {}
121+
122+# Add any paths that contain custom themes here, relative to this directory.
123+#html_theme_path = []
124+
125+# The name for this set of Sphinx documents. If None, it defaults to
126+# "<project> v<release> documentation".
127+#html_title = None
128+
129+# A shorter title for the navigation bar. Default is the same as html_title.
130+#html_short_title = None
131+
132+# The name of an image file (relative to this directory) to place at the top
133+# of the sidebar.
134+#html_logo = None
135+
136+# The name of an image file (within the static path) to use as favicon of the
137+# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
138+# pixels large.
139+#html_favicon = None
140+
141+# Add any paths that contain custom static files (such as style sheets) here,
142+# relative to this directory. They are copied after the builtin static files,
143+# so a file named "default.css" will overwrite the builtin "default.css".
144+html_static_path = ['static']
145+
146+# Add any extra paths that contain custom files (such as robots.txt or
147+# .htaccess) here, relative to this directory. These files are copied
148+# directly to the root of the documentation.
149+#html_extra_path = []
150+
151+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
152+# using the given strftime format.
153+#html_last_updated_fmt = '%b %d, %Y'
154+
155+# If true, SmartyPants will be used to convert quotes and dashes to
156+# typographically correct entities.
157+#html_use_smartypants = True
158+
159+# Custom sidebar templates, maps document names to template names.
160+#html_sidebars = {}
161+
162+# Additional templates that should be rendered to pages, maps page names to
163+# template names.
164+#html_additional_pages = {}
165+
166+# If false, no module index is generated.
167+#html_domain_indices = True
168+
169+# If false, no index is generated.
170+#html_use_index = True
171+
172+# If true, the index is split into individual pages for each letter.
173+#html_split_index = False
174+
175+# If true, links to the reST sources are added to the pages.
176+#html_show_sourcelink = True
177+
178+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
179+#html_show_sphinx = True
180+
181+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
182+#html_show_copyright = True
183+
184+# If true, an OpenSearch description file will be output, and all pages will
185+# contain a <link> tag referring to it. The value of this option must be the
186+# base URL from which the finished HTML is served.
187+#html_use_opensearch = ''
188+
189+# This is the file name suffix for HTML files (e.g. ".xhtml").
190+#html_file_suffix = None
191+
192+# Language to be used for generating the HTML full-text search index.
193+# Sphinx supports the following languages:
194+# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
195+# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
196+#html_search_language = 'en'
197+
198+# A dictionary with options for the search language support, empty by default.
199+# Now only 'ja' uses this config value
200+#html_search_options = {'type': 'default'}
201+
202+# The name of a javascript file (relative to the configuration directory) that
203+# implements a search results scorer. If empty, the default will be used.
204+#html_search_scorer = 'scorer.js'
205+
206+# Output file base name for HTML help builder.
207+htmlhelp_basename = 'searxdoc'
208+
209+# -- Options for LaTeX output ---------------------------------------------
210+
211+latex_elements = {
212+# The paper size ('letterpaper' or 'a4paper').
213+#'papersize': 'letterpaper',
214+
215+# The font size ('10pt', '11pt' or '12pt').
216+#'pointsize': '10pt',
217+
218+# Additional stuff for the LaTeX preamble.
219+#'preamble': '',
220+
221+# Latex figure (float) alignment
222+#'figure_align': 'htbp',
223+}
224+
225+# Grouping the document tree into LaTeX files. List of tuples
226+# (source start file, target name, title,
227+# author, documentclass [howto, manual, or own class]).
228+latex_documents = [
229+ (master_doc, 'searx.tex', u'searx Documentation',
230+ u'Adam Tauber', 'manual'),
231+]
232+
233+# The name of an image file (relative to this directory) to place at the top of
234+# the title page.
235+#latex_logo = None
236+
237+# For "manual" documents, if this is true, then toplevel headings are parts,
238+# not chapters.
239+#latex_use_parts = False
240+
241+# If true, show page references after internal links.
242+#latex_show_pagerefs = False
243+
244+# If true, show URL addresses after external links.
245+#latex_show_urls = False
246+
247+# Documents to append as an appendix to all manuals.
248+#latex_appendices = []
249+
250+# If false, no module index is generated.
251+#latex_domain_indices = True
252+
253+
254+# -- Options for manual page output ---------------------------------------
255+
256+# One entry per manual page. List of tuples
257+# (source start file, name, description, authors, manual section).
258+man_pages = [
259+ (master_doc, 'searx', u'searx Documentation',
260+ [author], 1)
261+]
262+
263+# If true, show URL addresses after external links.
264+#man_show_urls = False
265+
266+
267+# -- Options for Texinfo output -------------------------------------------
268+
269+# Grouping the document tree into Texinfo files. List of tuples
270+# (source start file, target name, title, author,
271+# dir menu entry, description, category)
272+texinfo_documents = [
273+ (master_doc, 'searx', u'searx Documentation',
274+ author, 'searx', 'One line description of project.',
275+ 'Miscellaneous'),
276+]
277+
278+# Documents to append as an appendix to all manuals.
279+#texinfo_appendices = []
280+
281+# If false, no module index is generated.
282+#texinfo_domain_indices = True
283+
284+# How to display URL addresses: 'footnote', 'no', or 'inline'.
285+#texinfo_show_urls = 'footnote'
286+
287+# If true, do not generate a @detailmenu in the "Top" node's menu.
288+#texinfo_no_detailmenu = False
289+
290+
291+# -- Options for Epub output ----------------------------------------------
292+
293+# Bibliographic Dublin Core info.
294+epub_title = project
295+epub_author = author
296+epub_publisher = author
297+epub_copyright = copyright
298+
299+# The basename for the epub file. It defaults to the project name.
300+#epub_basename = project
301+
302+# The HTML theme for the epub output. Since the default themes are not optimized
303+# for small screen space, using the same theme for HTML and epub output is
304+# usually not wise. This defaults to 'epub', a theme designed to save visual
305+# space.
306+#epub_theme = 'epub'
307+
308+# The language of the text. It defaults to the language option
309+# or 'en' if the language is not set.
310+#epub_language = ''
311+
312+# The scheme of the identifier. Typical schemes are ISBN or URL.
313+#epub_scheme = ''
314+
315+# The unique identifier of the text. This can be a ISBN number
316+# or the project homepage.
317+#epub_identifier = ''
318+
319+# A unique identification for the text.
320+#epub_uid = ''
321+
322+# A tuple containing the cover image and cover page html template filenames.
323+#epub_cover = ()
324+
325+# A sequence of (type, uri, title) tuples for the guide element of content.opf.
326+#epub_guide = ()
327+
328+# HTML files that should be inserted before the pages created by sphinx.
329+# The format is a list of tuples containing the path and title.
330+#epub_pre_files = []
331+
332+# HTML files shat should be inserted after the pages created by sphinx.
333+# The format is a list of tuples containing the path and title.
334+#epub_post_files = []
335+
336+# A list of files that should not be packed into the epub file.
337+epub_exclude_files = ['search.html']
338+
339+# The depth of the table of contents in toc.ncx.
340+#epub_tocdepth = 3
341+
342+# Allow duplicate toc entries.
343+#epub_tocdup = True
344+
345+# Choose between 'default' and 'includehidden'.
346+#epub_tocscope = 'default'
347+
348+# Fix unsupported image types using the Pillow.
349+#epub_fix_images = False
350+
351+# Scale large images.
352+#epub_max_image_width = 0
353+
354+# How to display URL addresses: 'footnote', 'no', or 'inline'.
355+#epub_show_urls = 'inline'
356+
357+# If false, no index is generated.
358+#epub_use_index = True