~ubuntu-branches/ubuntu/wily/nibabel/wily-proposed
» Revision
2
: .pc/no_doc_sources/doc/source/conf.py
« back to all changes in this revision
Viewing changes to .pc/no_doc_sources/doc/source/conf.py
- browse files at revision 2
- compare with another revision
- download diff
- download tarball
- view history from revision 2
- Committer: Bazaar Package Importer
- Author(s): Michael Hanke
- Date: 2010-10-15 08:20:14 UTC
- Revision ID: james.westby@ubuntu.com-20101015082014-g71kqsfvbrahbe4n
Tags: 1.0.0-1
Initial release (Closes: #600275).
- files added:
- .pc
- .pc/no_doc_sources
- .pc/no_doc_sources/doc
- .pc/no_doc_sources/doc/source
- debian
- debian/patches
- debian/source
- files modified:
- doc/source/conf.py
added
removed
.pc/no_doc_sources/doc/source/conf.py
1
# -*- coding: utf-8 -*-
2
# emacs: -*- mode: python-mode; py-indent-offset: 4; indent-tabs-mode: nil -*-
3
# vi: set ft=python sts=4 ts=4 sw=4 et:
4
### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ##
5
#
6
# See COPYING file distributed along with the NiBabel package for the
7
# copyright and license terms.
8
#
9
### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ##
10
#
11
# nipype documentation build configuration file, created by
12
# sphinx-quickstart on Mon Jul 20 12:30:18 2009.
13
#
14
# This file is execfile()d with the current directory set to its containing dir.
15
#
16
# Note that not all possible configuration values are present in this
17
# autogenerated file.
18
#
19
# All configuration values have a default; values that are commented out
20
# serve to show the default.
21
22
import sys, os
23
24
import nibabel
25
26
# If extensions (or modules to document with autodoc) are in another directory,
27
# add these directories to sys.path here. If the directory is relative to the
28
# documentation root, use os.path.abspath to make it absolute, like shown here.
29
sys.path.append(os.path.abspath('../sphinxext'))
30
31
# -- General configuration -----------------------------------------------------
32
33
# We load the nibabel release info into a dict by explicit execution
34
rel = {}
35
execfile('../../nibabel/info.py', rel)
36
37
# Add any Sphinx extension module names here, as strings. They can be extensions
38
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
39
extensions = ['sphinx.ext.autodoc',
40
'sphinx.ext.doctest',
41
#'sphinx.ext.intersphinx',
42
'sphinx.ext.todo',
43
'sphinx.ext.pngmath',
44
'sphinx.ext.inheritance_diagram',
45
# we have a local copy of autosummary from the unreleased sphinx
46
# 1.0 -- reason: the 0.6 extension creates half-empty summaries
47
'autosummary',
48
# we have a local copy of the extension, imported from NumPy 1.3
49
# this also includes the docscrape* extensions
50
'math_dollar', # has to go before numpydoc
51
'numpydoc',
52
'only_directives',
53
'math_dollar',
54
]
55
56
# the following doesn't work with sphinx < 1.0, but will make a separate
57
# sphinx-autogen run obsolete in the future
58
#autosummary_generate = True
59
60
# Add any paths that contain templates here, relative to this directory.
61
templates_path = ['_templates']
62
63
# The suffix of source filenames.
64
source_suffix = '.rst'
65
66
# The encoding of source files.
67
#source_encoding = 'utf-8'
68
69
# The master toctree document.
70
master_doc = 'index'
71
72
# General information about the project.
73
project = u'NiBabel'
74
copyright = u'2006-2010, %(MAINTAINER)s <%(AUTHOR_EMAIL)s>' % rel
75
76
# The version info for the project you're documenting, acts as replacement for
77
# |version| and |release|, also used in various other places throughout the
78
# built documents.
79
#
80
# The short X.Y version.
81
version = nibabel.__version__
82
# The full version, including alpha/beta/rc tags.
83
release = version
84
85
# The language for content autogenerated by Sphinx. Refer to documentation
86
# for a list of supported languages.
87
#language = None
88
89
# There are two options for replacing |today|: either, you set today to some
90
# non-false value, then it is used:
91
#today = ''
92
# Else, today_fmt is used as the format for a strftime call.
93
today_fmt = '%B %d, %Y, %H:%M PDT'
94
95
# List of documents that shouldn't be included in the build.
96
unused_docs = ['api/generated/gen']
97
98
# what to put into API doc (just class doc, just init, or both
99
autoclass_content = 'both'
100
101
# List of directories, relative to source directory, that shouldn't be searched
102
# for source files.
103
exclude_trees = ['_build']
104
105
# The reST default role (used for this markup: `text`) to use for all documents.
106
#default_role = None
107
108
# If true, '()' will be appended to :func: etc. cross-reference text.
109
#add_function_parentheses = True
110
111
# If true, the current module name will be prepended to all description
112
# unit titles (such as .. function::).
113
#add_module_names = True
114
115
# If true, sectionauthor and moduleauthor directives will be shown in the
116
# output. They are ignored by default.
117
#show_authors = False
118
119
# The name of the Pygments (syntax highlighting) style to use.
120
pygments_style = 'sphinx'
121
122
# A list of ignored prefixes for module index sorting.
123
#modindex_common_prefix = []
124
125
# -- Sphinxext configuration ---------------------------------------------------
126
127
# Set attributes for layout of inheritance diagrams
128
inheritance_graph_attrs = dict(rankdir="LR", size='"6.0, 8.0"', fontsize=14,
129
ratio='compress')
130
inheritance_node_attrs = dict(shape='ellipse', fontsize=14, height=0.75,
131
color='dodgerblue1', style='filled')
132
133
# Flag to show todo items in rendered output
134
todo_include_todos = True
135
136
# -- Options for HTML output ---------------------------------------------------
137
138
# The theme to use for HTML and HTML Help pages. Major themes that come with
139
# Sphinx are currently 'default' and 'sphinxdoc'.
140
html_theme = 'sphinxdoc'
141
142
# The style sheet to use for HTML and HTML Help pages. A file of that name
143
# must exist either in Sphinx' static/ path, or in one of the custom paths
144
# given in html_static_path.
145
html_style = 'nibabel.css'
146
147
# Theme options are theme-specific and customize the look and feel of a theme
148
# further. For a list of options available for each theme, see the
149
# documentation.
150
#html_theme_options = {}
151
152
# Add any paths that contain custom themes here, relative to this directory.
153
#html_theme_path = []
154
155
# The name for this set of Sphinx documents. If None, it defaults to
156
# "<project> v<release> documentation".
157
#html_title = ''
158
159
# A shorter title for the navigation bar. Default is the same as html_title.
160
#html_short_title = None
161
162
# The name of an image file (relative to this directory) to place at the top
163
# of the sidebar.
164
#html_logo = None
165
166
# The name of an image file (within the static path) to use as favicon of the
167
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
168
# pixels large.
169
#html_favicon = None
170
171
# Add any paths that contain custom static files (such as style sheets) here,
172
# relative to this directory. They are copied after the builtin static files,
173
# so a file named "default.css" will overwrite the builtin "default.css".
174
html_static_path = ['_static']
175
176
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
177
# using the given strftime format.
178
#html_last_updated_fmt = '%b %d, %Y'
179
180
# Content template for the index page.
181
html_index = 'index.html'
182
183
# If true, SmartyPants will be used to convert quotes and dashes to
184
# typographically correct entities.
185
#html_use_smartypants = True
186
187
# Custom sidebar templates, maps document names to template names.
188
html_sidebars = {'index': 'indexsidebar.html'}
189
190
# Additional templates that should be rendered to pages, maps page names to
191
# template names.
192
#html_additional_pages = {'index': 'index.html'}
193
194
# If false, no module index is generated.
195
#html_use_modindex = True
196
197
# If false, no index is generated.
198
#html_use_index = True
199
200
# If true, the index is split into individual pages for each letter.
201
#html_split_index = False
202
203
# If true, links to the reST sources are added to the pages.
204
html_show_sourcelink = True
205
206
# If true, an OpenSearch description file will be output, and all pages will
207
# contain a <link> tag referring to it. The value of this option must be the
208
# base URL from which the finished HTML is served.
209
#html_use_opensearch = ''
210
211
# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
212
#html_file_suffix = ''
213
214
# Output file base name for HTML help builder.
215
htmlhelp_basename = 'nibabeldoc'
216
217
218
# -- Options for LaTeX output --------------------------------------------------
219
220
# The paper size ('letter' or 'a4').
221
#latex_paper_size = 'letter'
222
223
# The font size ('10pt', '11pt' or '12pt').
224
#latex_font_size = '10pt'
225
226
# Grouping the document tree into LaTeX files. List of tuples
227
# (source start file, target name, title, author, documentclass [howto/manual]).
228
latex_documents = [
229
('index', 'nibabel.tex', u'NiBabel Documentation',
230
u'NiBabel Authors', 'manual'),
231
]
232
233
# The name of an image file (relative to this directory) to place at the top of
234
# the title page.
235
#latex_logo = None
236
237
# For "manual" documents, if this is true, then toplevel headings are parts,
238
# not chapters.
239
#latex_use_parts = False
240
241
# Additional stuff for the LaTeX preamble.
242
#latex_preamble = ''
243
244
# Documents to append as an appendix to all manuals.
245
#latex_appendices = []
246
247
# If false, no module index is generated.
248
#latex_use_modindex = True
249
250
251
# Example configuration for intersphinx: refer to the Python standard library.
252
intersphinx_mapping = {'http://docs.python.org/': None}
Loggerhead is a web-based interface for Breezy
Version: 2.0.1