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