git.iko.soy/typeable/servant
on servant-foreign-0.15.1 help sign in
typeable/servant/doc/conf.py
172 lines 5.3 kB history raw
1# -*- coding: utf-8 -*-
2#
3# Servant documentation build configuration file, created by
4# sphinx-quickstart on Fri Jul 6 11:38:51 2018.
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.
12# All configuration values have a default; values that are commented out
13# serve to show the default.
15# If extensions (or modules to document with autodoc) are in another directory,
16# add these directories to sys.path here. If the directory is relative to the
17# documentation root, use os.path.abspath to make it absolute, like shown here.
19# import os
20# import sys
21# sys.path.insert(0, os.path.abspath('.'))
22from recommonmark.parser import CommonMarkParser
25# -- General configuration ------------------------------------------------
27# If your documentation needs a minimal Sphinx version, state it here.
29# needs_sphinx = '1.0'
31# Add any Sphinx extension module names here, as strings. They can be
32# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
33# ones.
34extensions = []
36# Add any paths that contain templates here, relative to this directory.
37templates_path = ['_templates']
39# The suffix(es) of source filenames.
40# You can specify multiple suffix as a list of string:
42source_suffix = ['.rst', '.md', '.lhs']
44# The master toctree document.
45master_doc = 'index'
47# General information about the project.
48project = u'Servant'
49copyright = u'2018, Servant Contributors'
50author = u'Servant Contributors'
52# The version info for the project you're documenting, acts as replacement for
53# |version| and |release|, also used in various other places throughout the
54# built documents.
56# The short X.Y version.
57# version = u'0.14'
58# The full version, including alpha/beta/rc tags.
59# release = u'0.14'
61# The language for content autogenerated by Sphinx. Refer to documentation
62# for a list of supported languages.
64# This is also used if you do content translation via gettext catalogs.
65# Usually you set "language" from the command line for these cases.
66language = None
68# List of patterns, relative to source directory, that match files and
69# directories to ignore when looking for source files.
70# This patterns also effect to html_static_path and html_extra_path
71exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
73# The name of the Pygments (syntax highlighting) style to use.
74pygments_style = 'sphinx'
76# If true, `todo` and `todoList` produce output, else they produce nothing.
77todo_include_todos = False
80# -- Options for HTML output ----------------------------------------------
82# The theme to use for HTML and HTML Help pages. See the documentation for
83# a list of builtin themes.
85html_theme = 'sphinx_rtd_theme'
87# Theme options are theme-specific and customize the look and feel of a theme
88# further. For a list of options available for each theme, see the
89# documentation.
91# html_theme_options = {}
93# Add any paths that contain custom static files (such as style sheets) here,
94# relative to this directory. They are copied after the builtin static files,
95# so a file named "default.css" will overwrite the builtin "default.css".
96html_static_path = ['_static']
98# Custom sidebar templates, must be a dictionary that maps document names
99# to template names.
101# This is required for the alabaster theme
102# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
103html_sidebars = {
104 '**': [
105 'relations.html', # needs 'show_related': True theme option to display
106 'searchbox.html',
107 ]
111# -- Options for HTMLHelp output ------------------------------------------
113# Output file base name for HTML help builder.
114htmlhelp_basename = 'Servantdoc'
117# -- Options for LaTeX output ---------------------------------------------
119latex_elements = {
120 # The paper size ('letterpaper' or 'a4paper').
121 #
122 # 'papersize': 'letterpaper',
124 # The font size ('10pt', '11pt' or '12pt').
125 #
126 # 'pointsize': '10pt',
128 # Additional stuff for the LaTeX preamble.
129 #
130 # 'preamble': '',
132 # Latex figure (float) alignment
133 #
134 # 'figure_align': 'htbp',
137# Grouping the document tree into LaTeX files. List of tuples
138# (source start file, target name, title,
139# author, documentclass [howto, manual, or own class]).
140latex_documents = [
141 (master_doc, 'Servant.tex', u'Servant Documentation',
142 u'Servant Contributors', 'manual'),
146# -- Options for manual page output ---------------------------------------
148# One entry per manual page. List of tuples
149# (source start file, name, description, authors, manual section).
150man_pages = [
151 (master_doc, 'servant', u'Servant Documentation',
152 [author], 1)
156# -- Options for Texinfo output -------------------------------------------
158# Grouping the document tree into Texinfo files. List of tuples
159# (source start file, target name, title, author,
160# dir menu entry, description, category)
161texinfo_documents = [
162 (master_doc, 'Servant', u'Servant Documentation',
163 author, 'Servant', 'One line description of project.',
164 'Miscellaneous'),
167# -- Markdown -------------------------------------------------------------
169source_parsers = {
170 '.lhs': CommonMarkParser,