@@ -0,0 +1,288 @@
1+# -*- coding: utf-8 -*-
3+# servant documentation build configuration file, created by
4+# sphinx-quickstart on Mon Nov 23 13:24:36 2015.
6+# This file is execfile()d with the current directory set to its
9+# Note that not all possible configuration values are present in this
12+# All configuration values have a default; values that are commented out
13+# serve to show the default.
18+from recommonmark.parser import CommonMarkParser
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('.'))
25+# -- General configuration ------------------------------------------------
27+# If your documentation needs a minimal Sphinx version, state it here.
30+# Add any Sphinx extension module names here, as strings. They can be
31+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
35+# Add any paths that contain templates here, relative to this directory.
36+templates_path = ['_templates']
38+# The suffix(es) of source filenames.
39+# You can specify multiple suffix as a list of string:
40+source_suffix = ['.md', '.rst']
42+# The encoding of source files.
43+#source_encoding = 'utf-8-sig'
45+# The master toctree document.
48+# General information about the project.
50+copyright = u'2015-2016, Servant contributors'
51+author = u'Servant contributors'
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
57+# The short X.Y version.
59+# The full version, including alpha/beta/rc tags.
62+# The language for content autogenerated by Sphinx. Refer to documentation
63+# for a list of supported languages.
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.
69+# There are two options for replacing |today|: either, you set today to some
70+# non-false value, then it is used:
72+# Else, today_fmt is used as the format for a strftime call.
73+#today_fmt = '%B %d, %Y'
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']
79+# The reST default role (used for this markup: `text`) to use for all
83+# If true, '()' will be appended to :func: etc. cross-reference text.
84+#add_function_parentheses = True
86+# If true, the current module name will be prepended to all description
87+# unit titles (such as .. function::).
88+#add_module_names = True
90+# If true, sectionauthor and moduleauthor directives will be shown in the
91+# output. They are ignored by default.
94+# The name of the Pygments (syntax highlighting) style to use.
95+pygments_style = 'sphinx'
97+# A list of ignored prefixes for module index sorting.
98+#modindex_common_prefix = []
100+# If true, keep warnings as "system message" paragraphs in the built documents.
101+#keep_warnings = False
103+# If true, `todo` and `todoList` produce output, else they produce nothing.
104+todo_include_todos = False
107+# -- Options for HTML output ----------------------------------------------
109+# The theme to use for HTML and HTML Help pages. See the documentation for
110+# a list of builtin themes.
111+# html_theme = 'alabaster'
113+# Theme options are theme-specific and customize the look and feel of a theme
114+# further. For a list of options available for each theme, see the
116+#html_theme_options = {}
118+# Add any paths that contain custom themes here, relative to this directory.
119+#html_theme_path = []
121+# The name for this set of Sphinx documents. If None, it defaults to
122+# "<project> v<release> documentation".
125+# A shorter title for the navigation bar. Default is the same as html_title.
126+#html_short_title = None
128+# The name of an image file (relative to this directory) to place at the top
132+# The name of an image file (within the static path) to use as favicon of the
133+# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
137+# Add any paths that contain custom static files (such as style sheets) here,
138+# relative to this directory. They are copied after the builtin static files,
139+# so a file named "default.css" will overwrite the builtin "default.css".
140+html_static_path = ['_static']
142+# Add any extra paths that contain custom files (such as robots.txt or
143+# .htaccess) here, relative to this directory. These files are copied
144+# directly to the root of the documentation.
145+#html_extra_path = []
147+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
148+# using the given strftime format.
149+#html_last_updated_fmt = '%b %d, %Y'
151+# If true, SmartyPants will be used to convert quotes and dashes to
152+# typographically correct entities.
153+#html_use_smartypants = True
155+# Custom sidebar templates, maps document names to template names.
158+# Additional templates that should be rendered to pages, maps page names to
160+#html_additional_pages = {}
162+# If false, no module index is generated.
163+#html_domain_indices = True
165+# If false, no index is generated.
166+#html_use_index = True
168+# If true, the index is split into individual pages for each letter.
169+#html_split_index = False
171+# If true, links to the reST sources are added to the pages.
172+#html_show_sourcelink = True
174+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
175+#html_show_sphinx = True
177+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
178+#html_show_copyright = True
180+# If true, an OpenSearch description file will be output, and all pages will
181+# contain a <link> tag referring to it. The value of this option must be the
182+# base URL from which the finished HTML is served.
183+#html_use_opensearch = ''
185+# This is the file name suffix for HTML files (e.g. ".xhtml").
186+#html_file_suffix = None
188+# Language to be used for generating the HTML full-text search index.
189+# Sphinx supports the following languages:
190+# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
191+# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
192+#html_search_language = 'en'
194+# A dictionary with options for the search language support, empty by default.
195+# Now only 'ja' uses this config value
196+#html_search_options = {'type': 'default'}
198+# The name of a javascript file (relative to the configuration directory) that
199+# implements a search results scorer. If empty, the default will be used.
200+#html_search_scorer = 'scorer.js'
202+# Output file base name for HTML help builder.
203+htmlhelp_basename = 'servantdoc'
205+# -- Options for LaTeX output ---------------------------------------------
208+# The paper size ('letterpaper' or 'a4paper').
209+#'papersize': 'letterpaper',
211+# The font size ('10pt', '11pt' or '12pt').
212+#'pointsize': '10pt',
214+# Additional stuff for the LaTeX preamble.
217+# Latex figure (float) alignment
218+#'figure_align': 'htbp',
221+# Grouping the document tree into LaTeX files. List of tuples
222+# (source start file, target name, title,
223+# author, documentclass [howto, manual, or own class]).
225+ (master_doc, 'servant.tex', u'servant Documentation',
226+ u'Servant contributors', 'manual'),
229+# The name of an image file (relative to this directory) to place at the top of
233+# For "manual" documents, if this is true, then toplevel headings are parts,
235+#latex_use_parts = False
237+# If true, show page references after internal links.
238+#latex_show_pagerefs = False
240+# If true, show URL addresses after external links.
241+#latex_show_urls = False
243+# Documents to append as an appendix to all manuals.
244+#latex_appendices = []
246+# If false, no module index is generated.
247+#latex_domain_indices = True
250+# -- Options for manual page output ---------------------------------------
252+# One entry per manual page. List of tuples
253+# (source start file, name, description, authors, manual section).
255+ (master_doc, 'servant', u'servant Documentation',
259+# If true, show URL addresses after external links.
260+#man_show_urls = False
263+# -- Options for Texinfo output -------------------------------------------
265+# Grouping the document tree into Texinfo files. List of tuples
266+# (source start file, target name, title, author,
267+# dir menu entry, description, category)
268+texinfo_documents = [
269+ (master_doc, 'servant', u'servant Documentation',
270+ author, 'servant', 'One line description of project.',
274+# Documents to append as an appendix to all manuals.
275+#texinfo_appendices = []
277+# If false, no module index is generated.
278+#texinfo_domain_indices = True
280+# How to display URL addresses: 'footnote', 'no', or 'inline'.
281+#texinfo_show_urls = 'footnote'
283+# If true, do not generate a @detailmenu in the "Top" node's menu.
284+#texinfo_no_detailmenu = False
287+ '.md': CommonMarkParser,