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