source: doc/conf.py @ 244:bb294e835a2e

Last change on this file since 244:bb294e835a2e was 244:bb294e835a2e, checked in by Ralph Meijer <ralphm@…>, 2 years ago

Cut 18.0.0rc5

File size: 7.7 KB
Line 
1# -*- coding: utf-8 -*-
2#
3# Wokkel documentation build configuration file, created by
4# sphinx-quickstart on Mon May  7 11:15:38 2012.
5#
6# This file is execfile()d with the current directory set to its containing dir.
7#
8# Note that not all possible configuration values are present in this
9# autogenerated file.
10#
11# All configuration values have a default; values that are commented out
12# serve to show the default.
13
14# import sys, os
15
16# If extensions (or modules to document with autodoc) are in another directory,
17# add these directories to sys.path here. If the directory is relative to the
18# documentation root, use os.path.abspath to make it absolute, like shown here.
19#sys.path.insert(0, os.path.abspath('.'))
20
21# -- General configuration -----------------------------------------------------
22
23# If your documentation needs a minimal Sphinx version, state it here.
24#needs_sphinx = '1.0'
25
26# Add any Sphinx extension module names here, as strings. They can be extensions
27# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
28extensions = ['apilinks_sphinxext']
29
30# Add any paths that contain templates here, relative to this directory.
31templates_path = ['_templates']
32
33# The suffix of source filenames.
34source_suffix = '.rst'
35
36# The encoding of source files.
37#source_encoding = 'utf-8-sig'
38
39# The master toctree document.
40master_doc = 'index'
41
42# General information about the project.
43project = u'Wokkel'
44copyright = u'2003-2012, Ralph Meijer'
45
46# The version info for the project you're documenting, acts as replacement for
47# |version| and |release|, also used in various other places throughout the
48# built documents.
49#
50# The short X.Y version.
51version = '18.0.0'
52# The full version, including alpha/beta/rc tags.
53release = '18.0.0rc5'
54
55# The language for content autogenerated by Sphinx. Refer to documentation
56# for a list of supported languages.
57#language = None
58
59# There are two options for replacing |today|: either, you set today to some
60# non-false value, then it is used:
61#today = ''
62# Else, today_fmt is used as the format for a strftime call.
63#today_fmt = '%B %d, %Y'
64
65# List of patterns, relative to source directory, that match files and
66# directories to ignore when looking for source files.
67exclude_patterns = ['_build', 'listings']
68
69# The reST default role (used for this markup: `text`) to use for all documents.
70#default_role = None
71
72# If true, '()' will be appended to :func: etc. cross-reference text.
73#add_function_parentheses = True
74
75# If true, the current module name will be prepended to all description
76# unit titles (such as .. function::).
77#add_module_names = True
78
79# If true, sectionauthor and moduleauthor directives will be shown in the
80# output. They are ignored by default.
81#show_authors = False
82
83# The name of the Pygments (syntax highlighting) style to use.
84pygments_style = 'sphinx'
85
86# A list of ignored prefixes for module index sorting.
87#modindex_common_prefix = []
88
89# pydoctor API base URL
90apilinks_base_url = 'api/'
91
92
93# -- Options for HTML output ---------------------------------------------------
94
95# The theme to use for HTML and HTML Help pages.  See the documentation for
96# a list of builtin themes.
97html_theme = 'default'
98
99# Theme options are theme-specific and customize the look and feel of a theme
100# further.  For a list of options available for each theme, see the
101# documentation.
102#html_theme_options = {}
103
104# Add any paths that contain custom themes here, relative to this directory.
105#html_theme_path = []
106
107# The name for this set of Sphinx documents.  If None, it defaults to
108# "<project> v<release> documentation".
109#html_title = None
110
111# A shorter title for the navigation bar.  Default is the same as html_title.
112#html_short_title = None
113
114# The name of an image file (relative to this directory) to place at the top
115# of the sidebar.
116#html_logo = None
117
118# The name of an image file (within the static path) to use as favicon of the
119# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
120# pixels large.
121#html_favicon = None
122
123# Add any paths that contain custom static files (such as style sheets) here,
124# relative to this directory. They are copied after the builtin static files,
125# so a file named "default.css" will overwrite the builtin "default.css".
126html_static_path = []
127
128# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
129# using the given strftime format.
130#html_last_updated_fmt = '%b %d, %Y'
131
132# If true, SmartyPants will be used to convert quotes and dashes to
133# typographically correct entities.
134#html_use_smartypants = True
135
136# Custom sidebar templates, maps document names to template names.
137html_sidebars = {
138    'index': ['localtoc.html', 'indexsidebar.html', 'searchbox.html']
139    }
140
141# Additional templates that should be rendered to pages, maps page names to
142# template names.
143#html_additional_pages = {}
144
145# If false, no module index is generated.
146#html_domain_indices = True
147
148# If false, no index is generated.
149#html_use_index = True
150
151# If true, the index is split into individual pages for each letter.
152#html_split_index = False
153
154# If true, links to the reST sources are added to the pages.
155#html_show_sourcelink = True
156
157# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
158#html_show_sphinx = True
159
160# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
161#html_show_copyright = True
162
163# If true, an OpenSearch description file will be output, and all pages will
164# contain a <link> tag referring to it.  The value of this option must be the
165# base URL from which the finished HTML is served.
166#html_use_opensearch = ''
167
168# This is the file name suffix for HTML files (e.g. ".xhtml").
169#html_file_suffix = None
170
171# Output file base name for HTML help builder.
172htmlhelp_basename = 'Wokkeldoc'
173
174
175# -- Options for LaTeX output --------------------------------------------------
176
177latex_elements = {
178# The paper size ('letterpaper' or 'a4paper').
179#'papersize': 'letterpaper',
180
181# The font size ('10pt', '11pt' or '12pt').
182#'pointsize': '10pt',
183
184# Additional stuff for the LaTeX preamble.
185#'preamble': '',
186}
187
188# Grouping the document tree into LaTeX files. List of tuples
189# (source start file, target name, title, author, documentclass [howto/manual]).
190latex_documents = [
191  ('index', 'Wokkel.tex', u'Wokkel Documentation',
192   u'Ralph Meijer', 'manual'),
193]
194
195# The name of an image file (relative to this directory) to place at the top of
196# the title page.
197#latex_logo = None
198
199# For "manual" documents, if this is true, then toplevel headings are parts,
200# not chapters.
201#latex_use_parts = False
202
203# If true, show page references after internal links.
204#latex_show_pagerefs = False
205
206# If true, show URL addresses after external links.
207#latex_show_urls = False
208
209# Documents to append as an appendix to all manuals.
210#latex_appendices = []
211
212# If false, no module index is generated.
213#latex_domain_indices = True
214
215
216# -- Options for manual page output --------------------------------------------
217
218# One entry per manual page. List of tuples
219# (source start file, name, description, authors, manual section).
220man_pages = [
221    ('index', 'wokkel', u'Wokkel Documentation',
222     [u'Ralph Meijer'], 1)
223]
224
225# If true, show URL addresses after external links.
226#man_show_urls = False
227
228
229# -- Options for Texinfo output ------------------------------------------------
230
231# Grouping the document tree into Texinfo files. List of tuples
232# (source start file, target name, title, author,
233#  dir menu entry, description, category)
234texinfo_documents = [
235  ('index', 'Wokkel', u'Wokkel Documentation',
236   u'Ralph Meijer', 'Wokkel', 'One line description of project.',
237   'Miscellaneous'),
238]
239
240# Documents to append as an appendix to all manuals.
241#texinfo_appendices = []
242
243# If false, no module index is generated.
244#texinfo_domain_indices = True
245
246# How to display URL addresses: 'footnote', 'no', or 'inline'.
247#texinfo_show_urls = 'footnote'
Note: See TracBrowser for help on using the repository browser.