@@ -1,7 +1,7 @@
11# -*- coding: utf-8 -*-
22#
3−# servant documentation build configuration file, created by
4−# sphinx-quickstart on Mon Nov 23 13:24:36 2015.
3+# Servant documentation build configuration file, created by
4+# sphinx-quickstart on Fri Jul 6 11:38:51 2018.
55#
66# This file is execfile()d with the current directory set to its
77# containing dir.
@@ -12,20 +12,21 @@
1212# All configuration values have a default; values that are commented out
1313# serve to show the default.
1414
15−import sys
16−import os
17−import shlex
18−from recommonmark.parser import CommonMarkParser
19−
2015# If extensions (or modules to document with autodoc) are in another directory,
2116# add these directories to sys.path here. If the directory is relative to the
2217# documentation root, use os.path.abspath to make it absolute, like shown here.
23−#sys.path.insert(0, os.path.abspath('.'))
18+#
19+# import os
20+# import sys
21+# sys.path.insert(0, os.path.abspath('.'))
22+from recommonmark.parser import CommonMarkParser
23+
2424
2525# -- General configuration ------------------------------------------------
2626
2727# If your documentation needs a minimal Sphinx version, state it here.
28−#needs_sphinx = '1.0'
28+#
29+# needs_sphinx = '1.0'
2930
3031# Add any Sphinx extension module names here, as strings. They can be
3132# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
@@ -37,17 +38,15 @@ templates_path = ['_templates']
3738
3839# The suffix(es) of source filenames.
3940# 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'
41+#
42+source_suffix = ['.rst', '.md', '.lhs']
4443
4544# The master toctree document.
4645master_doc = 'index'
4746
4847# General information about the project.
49−project = u'servant'
50−copyright = u'2016, Servant Contributors'
48+project = u'Servant'
49+copyright = u'2018, Servant Contributors'
5150author = u'Servant Contributors'
5251
5352# The version info for the project you're documenting, acts as replacement for
@@ -55,9 +54,9 @@ author = u'Servant Contributors'
5554# built documents.
5655#
5756# The short X.Y version.
58−# version = 'latest'
57+# version = u'0.14'
5958# The full version, including alpha/beta/rc tags.
60−# release = 'latest'
59+# release = u'0.14'
6160
6261# The language for content autogenerated by Sphinx. Refer to documentation
6362# for a list of supported languages.
@@ -66,45 +65,14 @@ author = u'Servant Contributors'
6665# Usually you set "language" from the command line for these cases.
6766language = None
6867
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−
7568# List of patterns, relative to source directory, that match files and
7669# 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
70+# This patterns also effect to html_static_path and html_extra_path
71+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
9372
9473# The name of the Pygments (syntax highlighting) style to use.
9574pygments_style = 'sphinx'
9675
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−
10876# If true, `todo` and `todoList` produce output, else they produce nothing.
10977todo_include_todos = False
11078
@@ -113,157 +81,77 @@ todo_include_todos = False
11381
11482# The theme to use for HTML and HTML Help pages. See the documentation for
11583# a list of builtin themes.
84+#
11685html_theme = 'sphinx_rtd_theme'
11786
11887# Theme options are theme-specific and customize the look and feel of a theme
11988# further. For a list of options available for each theme, see the
12089# 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
90+#
91+# html_theme_options = {}
14192
14293# Add any paths that contain custom static files (such as style sheets) here,
14394# relative to this directory. They are copied after the builtin static files,
14495# so a file named "default.css" will overwrite the builtin "default.css".
14596html_static_path = ['_static']
14697
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'
98+# Custom sidebar templates, must be a dictionary that maps document names
99+# to template names.
100+#
101+# This is required for the alabaster theme
102+# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
103+html_sidebars = {
104+ '**': [
105+ 'relations.html', # needs 'show_related': True theme option to display
106+ 'searchbox.html',
107+ ]
108+}
198109
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'}
202110
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'
111+# -- Options for HTMLHelp output ------------------------------------------
206112
207113# Output file base name for HTML help builder.
208−htmlhelp_basename = 'servantdoc'
114+htmlhelp_basename = 'Servantdoc'
115+
209116
210117# -- Options for LaTeX output ---------------------------------------------
211118
212119latex_elements = {
213−# The paper size ('letterpaper' or 'a4paper').
214−#'papersize': 'letterpaper',
120+ # The paper size ('letterpaper' or 'a4paper').
121+ #
122+ # 'papersize': 'letterpaper',
215123
216−# The font size ('10pt', '11pt' or '12pt').
217−#'pointsize': '10pt',
124+ # The font size ('10pt', '11pt' or '12pt').
125+ #
126+ # 'pointsize': '10pt',
218127
219−# Additional stuff for the LaTeX preamble.
220−#'preamble': '',
128+ # Additional stuff for the LaTeX preamble.
129+ #
130+ # 'preamble': '',
221131
222−# Latex figure (float) alignment
223−#'figure_align': 'htbp',
132+ # Latex figure (float) alignment
133+ #
134+ # 'figure_align': 'htbp',
224135}
225136
226137# Grouping the document tree into LaTeX files. List of tuples
227138# (source start file, target name, title,
228139# author, documentclass [howto, manual, or own class]).
229140latex_documents = [
230− (master_doc, 'servant.tex', u'servant Documentation',
141+ (master_doc, 'Servant.tex', u'Servant Documentation',
231142 u'Servant Contributors', 'manual'),
232143]
233144
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−
254145
255146# -- Options for manual page output ---------------------------------------
256147
257148# One entry per manual page. List of tuples
258149# (source start file, name, description, authors, manual section).
259150man_pages = [
260− (master_doc, 'servant', u'servant Documentation',
151+ (master_doc, 'servant', u'Servant Documentation',
261152 [author], 1)
262153]
263154
264−# If true, show URL addresses after external links.
265−#man_show_urls = False
266−
267155
268156# -- Options for Texinfo output -------------------------------------------
269157
@@ -271,24 +159,15 @@ man_pages = [
271159# (source start file, target name, title, author,
272160# dir menu entry, description, category)
273161texinfo_documents = [
274− (master_doc, 'servant', u'servant Documentation',
275− author, 'servant', 'One line description of project.',
276− 'Miscellaneous'),
162+ (master_doc, 'Servant', u'Servant Documentation',
163+ author, 'Servant', 'One line description of project.',
164+ 'Miscellaneous'),
277165]
278166
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
167+# -- Markdown -------------------------------------------------------------
290168
291169source_parsers = {
292170 '.md': CommonMarkParser,
293171 '.lhs': CommonMarkParser,
294172}
173+