/[escript]/trunk/doc/sphinx_api/conf.py
ViewVC logotype

Contents of /trunk/doc/sphinx_api/conf.py

Parent Directory Parent Directory | Revision Log Revision Log


Revision 4167 - (show annotations)
Fri Jan 25 05:21:30 2013 UTC (6 years, 8 months ago) by jfenwick
File MIME type: text/x-python
File size: 9161 byte(s)
fixes for doco for earlier releases
1 # -*- coding: utf-8 -*-
2 #
3 # esys documentation build configuration file, created by
4 # sphinx-quickstart on Thu Dec 6 15:14:22 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
16 # If extensions (or modules to document with autodoc) are in another directory,
17 # add these directories to sys.path here. If the directory is relative to the
18 # documentation root, use os.path.abspath to make it absolute, like shown here.
19 #sys.path.insert(0, os.path.abspath('/home/joel/esys13/esys'))
20
21 # -- General configuration -----------------------------------------------------
22
23 # If your documentation needs a minimal Sphinx version, state it here.
24 needs_sphinx = '1.0' # For the autodoc_default_flags variable
25
26 autodoc_default_flags=['show-inheritance', 'inherited-members', 'members', 'undoc-members']
27
28 # Add any Sphinx extension module names here, as strings. They can be extensions
29 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
30 extensions = ['sphinx.ext.autodoc']
31
32 # Add any paths that contain templates here, relative to this directory.
33 templates_path = ['_templates']
34
35 # The suffix of source filenames.
36 source_suffix = '.rst'
37
38 # The encoding of source files.
39 #source_encoding = 'utf-8-sig'
40
41 # The master toctree document.
42 master_doc = 'index'
43
44 # General information about the project.
45 project = u'esys'
46 copyright = u'2012-2013, Author'
47
48 # The version info for the project you're documenting, acts as replacement for
49 # |version| and |release|, also used in various other places throughout the
50 # built documents.
51 #
52 # The short X.Y version.
53 version = ''
54 # The full version, including alpha/beta/rc tags.
55 release = ''
56
57 # The language for content autogenerated by Sphinx. Refer to documentation
58 # for a list of supported languages.
59 #language = None
60
61 # There are two options for replacing |today|: either, you set today to some
62 # non-false value, then it is used:
63 #today = ''
64 # Else, today_fmt is used as the format for a strftime call.
65 #today_fmt = '%B %d, %Y'
66
67 # List of patterns, relative to source directory, that match files and
68 # directories to ignore when looking for source files.
69 exclude_patterns = ['_build']
70
71 # The reST default role (used for this markup: `text`) to use for all documents.
72 default_role = 'obj'
73
74 # If true, '()' will be appended to :func: etc. cross-reference text.
75 #add_function_parentheses = True
76
77 # If true, the current module name will be prepended to all description
78 # unit titles (such as .. function::).
79 #add_module_names = True
80
81 # If true, sectionauthor and moduleauthor directives will be shown in the
82 # output. They are ignored by default.
83 #show_authors = False
84
85 # The name of the Pygments (syntax highlighting) style to use.
86 pygments_style = 'sphinx'
87
88 # A list of ignored prefixes for module index sorting.
89 #modindex_common_prefix = []
90
91
92 # -- Options for HTML output ---------------------------------------------------
93
94 # The theme to use for HTML and HTML Help pages. See the documentation for
95 # a list of builtin themes.
96 html_theme = 'default'
97
98 # Theme options are theme-specific and customize the look and feel of a theme
99 # further. For a list of options available for each theme, see the
100 # documentation.
101 #html_theme_options = {}
102
103 # Add any paths that contain custom themes here, relative to this directory.
104 #html_theme_path = []
105
106 # The name for this set of Sphinx documents. If None, it defaults to
107 # "<project> v<release> documentation".
108 #html_title = None
109
110 # A shorter title for the navigation bar. Default is the same as html_title.
111 #html_short_title = None
112
113 # The name of an image file (relative to this directory) to place at the top
114 # of the sidebar.
115 #html_logo = None
116
117 # The name of an image file (within the static path) to use as favicon of the
118 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
119 # pixels large.
120 #html_favicon = None
121
122 # Add any paths that contain custom static files (such as style sheets) here,
123 # relative to this directory. They are copied after the builtin static files,
124 # so a file named "default.css" will overwrite the builtin "default.css".
125 html_static_path = ['_static']
126
127 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
128 # using the given strftime format.
129 #html_last_updated_fmt = '%b %d, %Y'
130
131 # If true, SmartyPants will be used to convert quotes and dashes to
132 # typographically correct entities.
133 #html_use_smartypants = True
134
135 # Custom sidebar templates, maps document names to template names.
136 html_sidebars = {
137 '**': ['localtoc.html', 'relations.html']
138 }
139
140 # Additional templates that should be rendered to pages, maps page names to
141 # template names.
142 #html_additional_pages = {}
143
144 # If false, no module index is generated.
145 #html_domain_indices = True
146
147 # If false, no index is generated.
148 #html_use_index = True
149
150 # If true, the index is split into individual pages for each letter.
151 #html_split_index = False
152
153 # If true, links to the reST sources are added to the pages.
154 html_show_sourcelink = False
155
156 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
157 #html_show_sphinx = True
158
159 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
160 #html_show_copyright = True
161
162 # If true, an OpenSearch description file will be output, and all pages will
163 # contain a <link> tag referring to it. The value of this option must be the
164 # base URL from which the finished HTML is served.
165 #html_use_opensearch = ''
166
167 # This is the file name suffix for HTML files (e.g. ".xhtml").
168 #html_file_suffix = None
169
170 # Output file base name for HTML help builder.
171 htmlhelp_basename = 'esysdoc'
172
173
174 # -- Options for LaTeX output --------------------------------------------------
175
176 latex_elements = {
177 # The paper size ('letterpaper' or 'a4paper').
178 #'papersize': 'letterpaper',
179
180 # The font size ('10pt', '11pt' or '12pt').
181 #'pointsize': '10pt',
182
183 # Additional stuff for the LaTeX preamble.
184 #'preamble': '',
185 }
186
187 # Grouping the document tree into LaTeX files. List of tuples
188 # (source start file, target name, title, author, documentclass [howto/manual]).
189 latex_documents = [
190 ('index', 'esys.tex', u'esys.escript Documentation',
191 u'Author', 'manual'),
192 ]
193
194 # The name of an image file (relative to this directory) to place at the top of
195 # the title page.
196 #latex_logo = None
197
198 # For "manual" documents, if this is true, then toplevel headings are parts,
199 # not chapters.
200 #latex_use_parts = False
201
202 # If true, show page references after internal links.
203 #latex_show_pagerefs = False
204
205 # If true, show URL addresses after external links.
206 #latex_show_urls = False
207
208 # Documents to append as an appendix to all manuals.
209 #latex_appendices = []
210
211 # If false, no module index is generated.
212 #latex_domain_indices = True
213
214
215 # -- Options for manual page output --------------------------------------------
216
217 # One entry per manual page. List of tuples
218 # (source start file, name, description, authors, manual section).
219 man_pages = [
220 ('index', 'esys.escript', u'esys.escript Documentation',
221 [u'Author'], 1)
222 ]
223
224 # If true, show URL addresses after external links.
225 #man_show_urls = False
226
227
228 # -- Options for Texinfo output ------------------------------------------------
229
230 # Grouping the document tree into Texinfo files. List of tuples
231 # (source start file, target name, title, author,
232 # dir menu entry, description, category)
233 texinfo_documents = [
234 ('index', 'esys.escript', u'esys.escript Documentation',
235 u'Author', 'esys.escript', 'One line description of project.',
236 'Miscellaneous'),
237 ]
238
239 # Documents to append as an appendix to all manuals.
240 #texinfo_appendices = []
241
242 # If false, no module index is generated.
243 #texinfo_domain_indices = True
244
245 # How to display URL addresses: 'footnote', 'no', or 'inline'.
246 #texinfo_show_urls = 'footnote'
247
248
249 # -- Options for Epub output ---------------------------------------------------
250
251 # Bibliographic Dublin Core info.
252 epub_title = u'esys.escript'
253 epub_author = u'Author'
254 epub_publisher = u'Author'
255 epub_copyright = u'2012, Author'
256
257 # The language of the text. It defaults to the language option
258 # or en if the language is not set.
259 #epub_language = ''
260
261 # The scheme of the identifier. Typical schemes are ISBN or URL.
262 #epub_scheme = ''
263
264 # The unique identifier of the text. This can be a ISBN number
265 # or the project homepage.
266 #epub_identifier = ''
267
268 # A unique identification for the text.
269 #epub_uid = ''
270
271 # A tuple containing the cover image and cover page html template filenames.
272 #epub_cover = ()
273
274 # HTML files that should be inserted before the pages created by sphinx.
275 # The format is a list of tuples containing the path and title.
276 #epub_pre_files = []
277
278 # HTML files shat should be inserted after the pages created by sphinx.
279 # The format is a list of tuples containing the path and title.
280 #epub_post_files = []
281
282 # A list of files that should not be packed into the epub file.
283 #epub_exclude_files = []
284
285 # The depth of the table of contents in toc.ncx.
286 #epub_tocdepth = 3
287
288 # Allow duplicate toc entries.
289 #epub_tocdup = True

  ViewVC Help
Powered by ViewVC 1.1.26