1 | #!/usr/bin/env python3
|
---|
2 | # -*- coding: utf-8 -*-
|
---|
3 | #
|
---|
4 | # bnchelp documentation build configuration file, created by
|
---|
5 | # sphinx-quickstart on Wed Sep 14 17:09:43 2016.
|
---|
6 | #
|
---|
7 | # This file is execfile()d with the current directory set to its
|
---|
8 | # containing dir.
|
---|
9 | #
|
---|
10 | # Note that not all possible configuration values are present in this
|
---|
11 | # autogenerated file.
|
---|
12 | #
|
---|
13 | # All configuration values have a default; values that are commented out
|
---|
14 | # serve to show the default.
|
---|
15 |
|
---|
16 | import sys
|
---|
17 | import os
|
---|
18 |
|
---|
19 | # If extensions (or modules to document with autodoc) are in another directory,
|
---|
20 | # add these directories to sys.path here. If the directory is relative to the
|
---|
21 | # documentation root, use os.path.abspath to make it absolute, like shown here.
|
---|
22 | #sys.path.insert(0, os.path.abspath('.'))
|
---|
23 |
|
---|
24 | # -- General configuration ------------------------------------------------
|
---|
25 |
|
---|
26 | # If your documentation needs a minimal Sphinx version, state it here.
|
---|
27 | #needs_sphinx = '1.0'
|
---|
28 |
|
---|
29 | # Add any Sphinx extension module names here, as strings. They can be
|
---|
30 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
---|
31 | # ones.
|
---|
32 | extensions = [
|
---|
33 | 'sphinx.ext.autodoc',
|
---|
34 | 'sphinx.ext.todo',
|
---|
35 | 'sphinx.ext.coverage',
|
---|
36 | 'sphinx.ext.mathjax',
|
---|
37 | 'sphinxcontrib.bibtex'
|
---|
38 | ]
|
---|
39 |
|
---|
40 | # Add any paths that contain templates here, relative to this directory.
|
---|
41 | templates_path = ['_templates']
|
---|
42 |
|
---|
43 | # The suffix(es) of source filenames.
|
---|
44 | # You can specify multiple suffix as a list of string:
|
---|
45 | # source_suffix = ['.rst', '.md']
|
---|
46 | source_suffix = '.rst'
|
---|
47 |
|
---|
48 | # The encoding of source files.
|
---|
49 | source_encoding = 'utf-8-sig'
|
---|
50 |
|
---|
51 | # The master toctree document.
|
---|
52 | master_doc = 'bnchelp'
|
---|
53 |
|
---|
54 | # General information about the project.
|
---|
55 | project = 'BNC'
|
---|
56 | copyright = '2016, Weber, G., Mervart, L., Stuerze, A., Ruelke, A., Stoecker, D.'
|
---|
57 | author = 'Georg Weber, Leos Mervart, Andrea Stuerze, Axel Ruelke, Dirk Stoecker'
|
---|
58 |
|
---|
59 | # The version info for the project you're documenting, acts as replacement for
|
---|
60 | # |version| and |release|, also used in various other places throughout the
|
---|
61 | # built documents.
|
---|
62 | #
|
---|
63 | # The short X.Y version.
|
---|
64 | version = '2.13'
|
---|
65 | # The full version, including alpha/beta/rc tags.
|
---|
66 | release = '2.13'
|
---|
67 |
|
---|
68 | # The language for content autogenerated by Sphinx. Refer to documentation
|
---|
69 | # for a list of supported languages.
|
---|
70 | #
|
---|
71 | # This is also used if you do content translation via gettext catalogs.
|
---|
72 | # Usually you set "language" from the command line for these cases.
|
---|
73 | language = None
|
---|
74 |
|
---|
75 | # There are two options for replacing |today|: either, you set today to some
|
---|
76 | # non-false value, then it is used:
|
---|
77 | #today = ''
|
---|
78 | # Else, today_fmt is used as the format for a strftime call.
|
---|
79 | #today_fmt = '%B %d, %Y'
|
---|
80 |
|
---|
81 | # List of patterns, relative to source directory, that match files and
|
---|
82 | # directories to ignore when looking for source files.
|
---|
83 | # This patterns also effect to html_static_path and html_extra_path
|
---|
84 | exclude_patterns = []
|
---|
85 |
|
---|
86 | # The reST default role (used for this markup: `text`) to use for all
|
---|
87 | # documents.
|
---|
88 | #default_role = None
|
---|
89 |
|
---|
90 | # If true, '()' will be appended to :func: etc. cross-reference text.
|
---|
91 | #add_function_parentheses = True
|
---|
92 |
|
---|
93 | # If true, the current module name will be prepended to all description
|
---|
94 | # unit titles (such as .. function::).
|
---|
95 | #add_module_names = True
|
---|
96 |
|
---|
97 | # If true, sectionauthor and moduleauthor directives will be shown in the
|
---|
98 | # output. They are ignored by default.
|
---|
99 | #show_authors = False
|
---|
100 |
|
---|
101 | # The name of the Pygments (syntax highlighting) style to use.
|
---|
102 | pygments_style = 'sphinx'
|
---|
103 |
|
---|
104 | # A list of ignored prefixes for module index sorting.
|
---|
105 | #modindex_common_prefix = []
|
---|
106 |
|
---|
107 | # If true, keep warnings as "system message" paragraphs in the built documents.
|
---|
108 | #keep_warnings = False
|
---|
109 |
|
---|
110 | # If true, `todo` and `todoList` produce output, else they produce nothing.
|
---|
111 | todo_include_todos = True
|
---|
112 |
|
---|
113 |
|
---|
114 | # -- Options for HTML output ----------------------------------------------
|
---|
115 | numfig = True
|
---|
116 |
|
---|
117 | # The theme to use for HTML and HTML Help pages. See the documentation for
|
---|
118 | # a list of builtin themes.
|
---|
119 | html_theme = 'bizstyle'
|
---|
120 |
|
---|
121 | # Theme options are theme-specific and customize the look and feel of a theme
|
---|
122 | # further. For a list of options available for each theme, see the
|
---|
123 | # documentation.
|
---|
124 | #html_theme_options = {}
|
---|
125 |
|
---|
126 | # Add any paths that contain custom themes here, relative to this directory.
|
---|
127 | #html_theme_path = []
|
---|
128 |
|
---|
129 | # The name for this set of Sphinx documents.
|
---|
130 | # "<project> v<release> documentation" by default.
|
---|
131 | #html_title = 'bnchelp v2.13'
|
---|
132 |
|
---|
133 | # A shorter title for the navigation bar. Default is the same as html_title.
|
---|
134 | #html_short_title = None
|
---|
135 |
|
---|
136 | # The name of an image file (relative to this directory) to place at the top
|
---|
137 | # of the sidebar.
|
---|
138 | html_logo = 'figures/bnc_logo.png'
|
---|
139 |
|
---|
140 | # The name of an image file (relative to this directory) to use as a favicon of
|
---|
141 | # the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
---|
142 | # pixels large.
|
---|
143 | #html_favicon = None
|
---|
144 |
|
---|
145 | # Add any paths that contain custom static files (such as style sheets) here,
|
---|
146 | # relative to this directory. They are copied after the builtin static files,
|
---|
147 | # so a file named "default.css" will overwrite the builtin "default.css".
|
---|
148 | html_static_path = ['_static']
|
---|
149 |
|
---|
150 | # Add any extra paths that contain custom files (such as robots.txt or
|
---|
151 | # .htaccess) here, relative to this directory. These files are copied
|
---|
152 | # directly to the root of the documentation.
|
---|
153 | #html_extra_path = []
|
---|
154 |
|
---|
155 | # If not None, a 'Last updated on:' timestamp is inserted at every page
|
---|
156 | # bottom, using the given strftime format.
|
---|
157 | # The empty string is equivalent to '%b %d, %Y'.
|
---|
158 | #html_last_updated_fmt = None
|
---|
159 |
|
---|
160 | # If true, SmartyPants will be used to convert quotes and dashes to
|
---|
161 | # typographically correct entities.
|
---|
162 | #html_use_smartypants = True
|
---|
163 |
|
---|
164 | # Custom sidebar templates, maps document names to template names.
|
---|
165 | #html_sidebars = {}
|
---|
166 |
|
---|
167 | # Additional templates that should be rendered to pages, maps page names to
|
---|
168 | # template names.
|
---|
169 | #html_additional_pages = {}
|
---|
170 |
|
---|
171 | # If false, no module index is generated.
|
---|
172 | html_domain_indices = False
|
---|
173 |
|
---|
174 | # If false, no index is generated.
|
---|
175 | html_use_index = True
|
---|
176 |
|
---|
177 | # If true, the index is split into individual pages for each letter.
|
---|
178 | #html_split_index = False
|
---|
179 |
|
---|
180 | # If true, links to the reST sources are added to the pages.
|
---|
181 | #html_show_sourcelink = True
|
---|
182 |
|
---|
183 | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
---|
184 | html_show_sphinx = True
|
---|
185 |
|
---|
186 | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
---|
187 | html_show_copyright = True
|
---|
188 |
|
---|
189 | # If true, an OpenSearch description file will be output, and all pages will
|
---|
190 | # contain a <link> tag referring to it. The value of this option must be the
|
---|
191 | # base URL from which the finished HTML is served.
|
---|
192 | #html_use_opensearch = ''
|
---|
193 |
|
---|
194 | # This is the file name suffix for HTML files (e.g. ".xhtml").
|
---|
195 | #html_file_suffix = None
|
---|
196 |
|
---|
197 | # Language to be used for generating the HTML full-text search index.
|
---|
198 | # Sphinx supports the following languages:
|
---|
199 | # 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'
|
---|
200 | # 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr', 'zh'
|
---|
201 | #html_search_language = 'en'
|
---|
202 |
|
---|
203 | # A dictionary with options for the search language support, empty by default.
|
---|
204 | # 'ja' uses this config value.
|
---|
205 | # 'zh' user can custom change `jieba` dictionary path.
|
---|
206 | #html_search_options = {'type': 'default'}
|
---|
207 |
|
---|
208 | # The name of a javascript file (relative to the configuration directory) that
|
---|
209 | # implements a search results scorer. If empty, the default will be used.
|
---|
210 | #html_search_scorer = 'scorer.js'
|
---|
211 |
|
---|
212 | # Output file base name for HTML help builder.
|
---|
213 | htmlhelp_basename = 'bncdoc'
|
---|
214 |
|
---|
215 | # -- Options for LaTeX output ---------------------------------------------
|
---|
216 | ADDITIONAL_PREAMBLE = """
|
---|
217 | \input{../../source/preamble._tex}
|
---|
218 | \usepackage{sphinx}
|
---|
219 | \definecolor{TitleColor}{rgb}{0,0,0}
|
---|
220 | \definecolor{InnerLinkColor}{rgb}{0,0,0}
|
---|
221 | """
|
---|
222 |
|
---|
223 | ADDITIONAL_FOOTER = """
|
---|
224 | \input{../../source/footer._tex}
|
---|
225 | """
|
---|
226 |
|
---|
227 | MAKE_TITLE = """
|
---|
228 | \glsaddall
|
---|
229 | \\tableofcontents
|
---|
230 | \cleardoublepage
|
---|
231 | \\addcontentsline{toc}{chapter}{\listfigurename}
|
---|
232 | \listoffigures
|
---|
233 | \cleardoublepage
|
---|
234 | \\addcontentsline{toc}{chapter}{\listtablename}
|
---|
235 | \listoftables
|
---|
236 | \cleardoublepage
|
---|
237 | """
|
---|
238 |
|
---|
239 | latex_elements = {
|
---|
240 | # The paper size ('letterpaper' or 'a4paper').
|
---|
241 | #'papersize': 'letterpaper',
|
---|
242 |
|
---|
243 | # The font size ('10pt', '11pt' or '12pt').
|
---|
244 | 'pointsize': '10pt',
|
---|
245 |
|
---|
246 | # Additional stuff for the LaTeX preamble.
|
---|
247 | 'preamble': ADDITIONAL_PREAMBLE,
|
---|
248 |
|
---|
249 | # Additional footer
|
---|
250 | 'footer': ADDITIONAL_FOOTER,
|
---|
251 |
|
---|
252 | # Latex figure (float) alignment
|
---|
253 | 'figure_align': 'h',
|
---|
254 |
|
---|
255 | # override maketitle
|
---|
256 | 'maketitle': MAKE_TITLE,
|
---|
257 |
|
---|
258 | 'inputenc': '\\usepackage[ansinew]{inputenc}'
|
---|
259 | }
|
---|
260 |
|
---|
261 | # disable index printing
|
---|
262 | # 'printindex': '',
|
---|
263 |
|
---|
264 |
|
---|
265 |
|
---|
266 |
|
---|
267 | # Grouping the document tree into LaTeX files. List of tuples
|
---|
268 | # (source start file, target name, title,
|
---|
269 | # author, documentclass [howto, manual, or own class]).
|
---|
270 | latex_documents = [
|
---|
271 | (master_doc, 'bnc.tex', u'BKG Ntrip Client',
|
---|
272 | u'G. Weber L. Mervart A. St{\\"u}rze A. R{\\"u}lke D. St{\\"o}cker', 'manual'),
|
---|
273 | ]
|
---|
274 |
|
---|
275 | # The name of an image file (relative to this directory) to place at the top of
|
---|
276 | # the title page.
|
---|
277 | #latex_logo = None
|
---|
278 |
|
---|
279 | # For "manual" documents, if this is true, then toplevel headings are parts,
|
---|
280 | # not chapters.
|
---|
281 | #latex_use_parts = False
|
---|
282 |
|
---|
283 | # If true, show page references after internal links.
|
---|
284 | #latex_show_pagerefs = False
|
---|
285 |
|
---|
286 | # If true, show URL addresses after external links.
|
---|
287 | #latex_show_urls = False
|
---|
288 |
|
---|
289 | # Documents to append as an appendix to all manuals.
|
---|
290 | #latex_appendices = []
|
---|
291 |
|
---|
292 | # If false, no module index is generated.
|
---|
293 | latex_domain_indices = False
|
---|
294 |
|
---|
295 |
|
---|
296 | # -- Options for manual page output ---------------------------------------
|
---|
297 |
|
---|
298 | # One entry per manual page. List of tuples
|
---|
299 | # (source start file, name, description, authors, manual section).
|
---|
300 | man_pages = [
|
---|
301 | (master_doc, 'bnc', 'BNC Documentation',
|
---|
302 | [author], 1)
|
---|
303 | ]
|
---|
304 |
|
---|
305 | # If true, show URL addresses after external links.
|
---|
306 | #man_show_urls = False
|
---|
307 |
|
---|
308 |
|
---|
309 | # -- Options for Texinfo output -------------------------------------------
|
---|
310 |
|
---|
311 | # Grouping the document tree into Texinfo files. List of tuples
|
---|
312 | # (source start file, target name, title, author,
|
---|
313 | # dir menu entry, description, category)
|
---|
314 | texinfo_documents = [
|
---|
315 | (master_doc, 'bnchelp', 'bnchelp Documentation',
|
---|
316 | author, 'bnchelp', 'One line description of project.',
|
---|
317 | 'Miscellaneous'),
|
---|
318 | ]
|
---|
319 |
|
---|
320 | # Documents to append as an appendix to all manuals.
|
---|
321 | #texinfo_appendices = []
|
---|
322 |
|
---|
323 | # If false, no module index is generated.
|
---|
324 | #texinfo_domain_indices = True
|
---|
325 |
|
---|
326 | # How to display URL addresses: 'footnote', 'no', or 'inline'.
|
---|
327 | #texinfo_show_urls = 'footnote'
|
---|
328 |
|
---|
329 | # If true, do not generate a @detailmenu in the "Top" node's menu.
|
---|
330 | #texinfo_no_detailmenu = False
|
---|