annotate python/doc/conf.py @ 273:6b3a874edd6e

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