tmp
[blender.git] / extern / audaspace / bindings / doc / conf.py.in
1 #!/usr/bin/env python3
2 # -*- coding: utf-8 -*-
3 #
4 # audaspace documentation build configuration file, created by
5 # sphinx-quickstart on Tue Sep  9 01:48:48 2014.
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 ]
35
36 # Add any paths that contain templates here, relative to this directory.
37 templates_path = []
38
39 # The suffix of source filenames.
40 source_suffix = '.rst'
41
42 # The encoding of source files.
43 #source_encoding = 'utf-8-sig'
44
45 # The master toctree document.
46 master_doc = 'index'
47
48 # General information about the project.
49 project = 'audaspace'
50 copyright = '2009-2015, Jörg Müller'
51
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.
55 #
56 # The short X.Y version.
57 version = '@AUDASPACE_VERSION@'
58 # The full version, including alpha/beta/rc tags.
59 release = '@AUDASPACE_LONG_VERSION@'
60
61 # The language for content autogenerated by Sphinx. Refer to documentation
62 # for a list of supported languages.
63 #language = None
64
65 # There are two options for replacing |today|: either, you set today to some
66 # non-false value, then it is used:
67 #today = ''
68 # Else, today_fmt is used as the format for a strftime call.
69 #today_fmt = '%B %d, %Y'
70
71 # List of patterns, relative to source directory, that match files and
72 # directories to ignore when looking for source files.
73 exclude_patterns = []
74
75 # The reST default role (used for this markup: `text`) to use for all
76 # documents.
77 #default_role = None
78
79 # If true, '()' will be appended to :func: etc. cross-reference text.
80 #add_function_parentheses = True
81
82 # If true, the current module name will be prepended to all description
83 # unit titles (such as .. function::).
84 #add_module_names = True
85
86 # If true, sectionauthor and moduleauthor directives will be shown in the
87 # output. They are ignored by default.
88 #show_authors = False
89
90 # The name of the Pygments (syntax highlighting) style to use.
91 pygments_style = 'sphinx'
92
93 # A list of ignored prefixes for module index sorting.
94 #modindex_common_prefix = []
95
96 # If true, keep warnings as "system message" paragraphs in the built documents.
97 #keep_warnings = False
98
99
100 # -- Options for HTML output ----------------------------------------------
101
102 # The theme to use for HTML and HTML Help pages.  See the documentation for
103 # a list of builtin themes.
104 html_theme = 'alabaster'
105
106 # Theme options are theme-specific and customize the look and feel of a theme
107 # further.  For a list of options available for each theme, see the
108 # documentation.
109 #html_theme_options = {}
110
111 # Add any paths that contain custom themes here, relative to this directory.
112 #html_theme_path = []
113
114 # The name for this set of Sphinx documents.  If None, it defaults to
115 # "<project> v<release> documentation".
116 #html_title = None
117
118 # A shorter title for the navigation bar.  Default is the same as html_title.
119 #html_short_title = None
120
121 # The name of an image file (relative to this directory) to place at the top
122 # of the sidebar.
123 #html_logo = None
124
125 # The name of an image file (within the static path) to use as favicon of the
126 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
127 # pixels large.
128 #html_favicon = None
129
130 # Add any paths that contain custom static files (such as style sheets) here,
131 # relative to this directory. They are copied after the builtin static files,
132 # so a file named "default.css" will overwrite the builtin "default.css".
133 html_static_path = []
134
135 # Add any extra paths that contain custom files (such as robots.txt or
136 # .htaccess) here, relative to this directory. These files are copied
137 # directly to the root of the documentation.
138 #html_extra_path = []
139
140 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
141 # using the given strftime format.
142 #html_last_updated_fmt = '%b %d, %Y'
143
144 # If true, SmartyPants will be used to convert quotes and dashes to
145 # typographically correct entities.
146 #html_use_smartypants = True
147
148 # Custom sidebar templates, maps document names to template names.
149 #html_sidebars = {}
150
151 # Additional templates that should be rendered to pages, maps page names to
152 # template names.
153 #html_additional_pages = {}
154
155 # If false, no module index is generated.
156 #html_domain_indices = True
157
158 # If false, no index is generated.
159 #html_use_index = True
160
161 # If true, the index is split into individual pages for each letter.
162 #html_split_index = False
163
164 # If true, links to the reST sources are added to the pages.
165 #html_show_sourcelink = True
166
167 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
168 #html_show_sphinx = True
169
170 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
171 #html_show_copyright = True
172
173 # If true, an OpenSearch description file will be output, and all pages will
174 # contain a <link> tag referring to it.  The value of this option must be the
175 # base URL from which the finished HTML is served.
176 #html_use_opensearch = ''
177
178 # This is the file name suffix for HTML files (e.g. ".xhtml").
179 #html_file_suffix = None
180
181 # Output file base name for HTML help builder.
182 htmlhelp_basename = 'audaspacedoc'
183
184
185 # -- Options for LaTeX output ---------------------------------------------
186
187 latex_elements = {
188 # The paper size ('letterpaper' or 'a4paper').
189 #'papersize': 'letterpaper',
190
191 # The font size ('10pt', '11pt' or '12pt').
192 #'pointsize': '10pt',
193
194 # Additional stuff for the LaTeX preamble.
195 #'preamble': '',
196 }
197
198 # Grouping the document tree into LaTeX files. List of tuples
199 # (source start file, target name, title,
200 #  author, documentclass [howto, manual, or own class]).
201 latex_documents = [
202   ('index', 'audaspace.tex', 'audaspace Documentation',
203    'Jörg Müller', 'manual'),
204 ]
205
206 # The name of an image file (relative to this directory) to place at the top of
207 # the title page.
208 #latex_logo = None
209
210 # For "manual" documents, if this is true, then toplevel headings are parts,
211 # not chapters.
212 #latex_use_parts = False
213
214 # If true, show page references after internal links.
215 #latex_show_pagerefs = False
216
217 # If true, show URL addresses after external links.
218 #latex_show_urls = False
219
220 # Documents to append as an appendix to all manuals.
221 #latex_appendices = []
222
223 # If false, no module index is generated.
224 #latex_domain_indices = True
225
226
227 # -- Options for manual page output ---------------------------------------
228
229 # One entry per manual page. List of tuples
230 # (source start file, name, description, authors, manual section).
231 man_pages = [
232     ('index', 'audaspace', 'audaspace Documentation',
233      ['Jörg Müller'], 1)
234 ]
235
236 # If true, show URL addresses after external links.
237 #man_show_urls = False
238
239
240 # -- Options for Texinfo output -------------------------------------------
241
242 # Grouping the document tree into Texinfo files. List of tuples
243 # (source start file, target name, title, author,
244 #  dir menu entry, description, category)
245 texinfo_documents = [
246   ('index', 'audaspace', 'audaspace Documentation',
247    'Jörg Müller', 'audaspace', 'One line description of project.',
248    'Miscellaneous'),
249 ]
250
251 # Documents to append as an appendix to all manuals.
252 #texinfo_appendices = []
253
254 # If false, no module index is generated.
255 #texinfo_domain_indices = True
256
257 # How to display URL addresses: 'footnote', 'no', or 'inline'.
258 #texinfo_show_urls = 'footnote'
259
260 # If true, do not generate a @detailmenu in the "Top" node's menu.
261 #texinfo_no_detailmenu = False