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