|
19 | 19 | # All configuration values have a default; values that are commented out
|
20 | 20 | # serve to show the default.
|
21 | 21 |
|
22 |
| -import sys |
23 | 22 | import os
|
24 | 23 | from runpy import run_path
|
25 | 24 | from configparser import ConfigParser
|
26 | 25 |
|
27 | 26 | # Check for external Sphinx extensions we depend on
|
28 | 27 | try:
|
29 |
| - import numpydoc |
| 28 | + import numpydoc # noqa: F401 |
30 | 29 | except ImportError:
|
31 | 30 | raise RuntimeError('Need to install "numpydoc" package for doc build')
|
32 | 31 | try:
|
33 |
| - import texext |
| 32 | + import texext # noqa: F401 |
34 | 33 | except ImportError:
|
35 | 34 | raise RuntimeError('Need to install "texext" package for doc build')
|
36 | 35 |
|
|
64 | 63 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
65 | 64 | extensions = ['sphinx.ext.autodoc',
|
66 | 65 | 'sphinx.ext.doctest',
|
67 |
| - #'sphinx.ext.intersphinx', |
68 | 66 | 'sphinx.ext.todo',
|
69 | 67 | 'sphinx.ext.mathjax',
|
70 | 68 | 'sphinx.ext.inheritance_diagram',
|
|
76 | 74 |
|
77 | 75 | # the following doesn't work with sphinx < 1.0, but will make a separate
|
78 | 76 | # sphinx-autogen run obsolete in the future
|
79 |
| -#autosummary_generate = True |
| 77 | +# autosummary_generate = True |
80 | 78 |
|
81 | 79 | # Add any paths that contain templates here, relative to this directory.
|
82 | 80 | templates_path = ['_templates']
|
|
85 | 83 | source_suffix = '.rst'
|
86 | 84 |
|
87 | 85 | # The encoding of source files.
|
88 |
| -#source_encoding = 'utf-8' |
| 86 | +# source_encoding = 'utf-8' |
89 | 87 |
|
90 | 88 | # The master toctree document.
|
91 | 89 | master_doc = 'index'
|
|
105 | 103 |
|
106 | 104 | # The language for content autogenerated by Sphinx. Refer to documentation
|
107 | 105 | # for a list of supported languages.
|
108 |
| -#language = None |
| 106 | +# language = None |
109 | 107 |
|
110 | 108 | # There are two options for replacing |today|: either, you set today to some
|
111 | 109 | # non-false value, then it is used:
|
112 |
| -#today = '' |
| 110 | +# today = '' |
113 | 111 | # Else, today_fmt is used as the format for a strftime call.
|
114 | 112 | today_fmt = '%B %d, %Y, %H:%M PDT'
|
115 | 113 |
|
|
124 | 122 | exclude_trees = ['_build']
|
125 | 123 |
|
126 | 124 | # The reST default role (used for this markup: `text`) to use for all documents
|
127 |
| -#default_role = None |
| 125 | +# default_role = None |
128 | 126 |
|
129 | 127 | # If true, '()' will be appended to :func: etc. cross-reference text.
|
130 |
| -#add_function_parentheses = True |
| 128 | +# add_function_parentheses = True |
131 | 129 |
|
132 | 130 | # If true, the current module name will be prepended to all description
|
133 | 131 | # unit titles (such as .. function::).
|
134 |
| -#add_module_names = True |
| 132 | +# add_module_names = True |
135 | 133 |
|
136 | 134 | # If true, sectionauthor and moduleauthor directives will be shown in the
|
137 | 135 | # output. They are ignored by default.
|
138 |
| -#show_authors = False |
| 136 | +# show_authors = False |
139 | 137 |
|
140 | 138 | # The name of the Pygments (syntax highlighting) style to use.
|
141 | 139 | pygments_style = 'sphinx'
|
142 | 140 |
|
143 | 141 | # A list of ignored prefixes for module index sorting.
|
144 |
| -#modindex_common_prefix = [] |
| 142 | +# modindex_common_prefix = [] |
145 | 143 |
|
146 | 144 | # -- Sphinxext configuration --------------------------------------------------
|
147 | 145 |
|
|
168 | 166 | # Theme options are theme-specific and customize the look and feel of a theme
|
169 | 167 | # further. For a list of options available for each theme, see the
|
170 | 168 | # documentation.
|
171 |
| -#html_theme_options = {} |
| 169 | +# html_theme_options = {} |
172 | 170 |
|
173 | 171 | # Add any paths that contain custom themes here, relative to this directory.
|
174 |
| -#html_theme_path = [] |
| 172 | +# html_theme_path = [] |
175 | 173 |
|
176 | 174 | # The name for this set of Sphinx documents. If None, it defaults to
|
177 | 175 | # "<project> v<release> documentation".
|
178 |
| -#html_title = '' |
| 176 | +# html_title = '' |
179 | 177 |
|
180 | 178 | # A shorter title for the navigation bar. Default is the same as html_title.
|
181 |
| -#html_short_title = None |
| 179 | +# html_short_title = None |
182 | 180 |
|
183 | 181 | # The name of an image file (relative to this directory) to place at the top
|
184 | 182 | # of the sidebar.
|
185 |
| -#html_logo = None |
| 183 | +# html_logo = None |
186 | 184 |
|
187 | 185 | # The name of an image file (within the static path) to use as favicon of the
|
188 | 186 | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
189 | 187 | # pixels large.
|
190 |
| -#html_favicon = None |
| 188 | +# html_favicon = None |
191 | 189 |
|
192 | 190 | # Add any paths that contain custom static files (such as style sheets) here,
|
193 | 191 | # relative to this directory. They are copied after the builtin static files,
|
|
196 | 194 |
|
197 | 195 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
198 | 196 | # using the given strftime format.
|
199 |
| -#html_last_updated_fmt = '%b %d, %Y' |
| 197 | +# html_last_updated_fmt = '%b %d, %Y' |
200 | 198 |
|
201 | 199 | # Content template for the index page.
|
202 | 200 | html_index = 'index.html'
|
203 | 201 |
|
204 | 202 | # If true, SmartyPants will be used to convert quotes and dashes to
|
205 | 203 | # typographically correct entities.
|
206 |
| -#html_use_smartypants = True |
| 204 | +# html_use_smartypants = True |
207 | 205 |
|
208 | 206 | # Custom sidebar templates, maps document names to template names.
|
209 | 207 | html_sidebars = {'index': ['localtoc.html', 'relations.html', 'sourcelink.html',
|
210 | 208 | 'indexsidebar.html', 'searchbox.html', 'reggie.html']}
|
211 | 209 |
|
212 | 210 | # Additional templates that should be rendered to pages, maps page names to
|
213 | 211 | # template names.
|
214 |
| -#html_additional_pages = {'index': 'index.html'} |
| 212 | +# html_additional_pages = {'index': 'index.html'} |
215 | 213 |
|
216 | 214 | # If false, no module index is generated.
|
217 |
| -#html_use_modindex = True |
| 215 | +# html_use_modindex = True |
218 | 216 |
|
219 | 217 | # If false, no index is generated.
|
220 |
| -#html_use_index = True |
| 218 | +# html_use_index = True |
221 | 219 |
|
222 | 220 | # If true, the index is split into individual pages for each letter.
|
223 |
| -#html_split_index = False |
| 221 | +# html_split_index = False |
224 | 222 |
|
225 | 223 | # If true, links to the reST sources are added to the pages.
|
226 | 224 | html_show_sourcelink = True
|
227 | 225 |
|
228 | 226 | # If true, an OpenSearch description file will be output, and all pages will
|
229 | 227 | # contain a <link> tag referring to it. The value of this option must be the
|
230 | 228 | # base URL from which the finished HTML is served.
|
231 |
| -#html_use_opensearch = '' |
| 229 | +# html_use_opensearch = '' |
232 | 230 |
|
233 | 231 | # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
|
234 |
| -#html_file_suffix = '' |
| 232 | +# html_file_suffix = '' |
235 | 233 |
|
236 | 234 | # Output file base name for HTML help builder.
|
237 | 235 | htmlhelp_basename = 'nibabeldoc'
|
|
241 | 239 | # -- Options for LaTeX output -------------------------------------------------
|
242 | 240 |
|
243 | 241 | # The paper size ('letter' or 'a4').
|
244 |
| -#latex_paper_size = 'letter' |
| 242 | +# latex_paper_size = 'letter' |
245 | 243 |
|
246 | 244 | # The font size ('10pt', '11pt' or '12pt').
|
247 |
| -#latex_font_size = '10pt' |
| 245 | +# latex_font_size = '10pt' |
248 | 246 |
|
249 | 247 | # Grouping the document tree into LaTeX files. List of tuples
|
250 | 248 | # (source start file, target name, title, author,
|
251 |
| -# documentclass [howto/manual]). |
| 249 | +# documentclass [howto/manual]). |
252 | 250 | latex_documents = [
|
253 | 251 | ('index', 'nibabel.tex', u'NiBabel Documentation', u'NiBabel Authors',
|
254 | 252 | 'manual')]
|
255 | 253 |
|
256 | 254 | # The name of an image file (relative to this directory) to place at the top of
|
257 | 255 | # the title page.
|
258 |
| -#latex_logo = None |
| 256 | +# latex_logo = None |
259 | 257 |
|
260 | 258 | # For "manual" documents, if this is true, then toplevel headings are parts,
|
261 | 259 | # not chapters.
|
262 |
| -#latex_use_parts = False |
| 260 | +# latex_use_parts = False |
263 | 261 |
|
264 | 262 | # Additional stuff for the LaTeX preamble.
|
265 |
| -#latex_preamble = '' |
| 263 | +# latex_preamble = '' |
266 | 264 |
|
267 | 265 | # Documents to append as an appendix to all manuals.
|
268 |
| -#latex_appendices = [] |
| 266 | +# latex_appendices = [] |
269 | 267 |
|
270 | 268 | # If false, no module index is generated.
|
271 |
| -#latex_use_modindex = True |
| 269 | +# latex_use_modindex = True |
272 | 270 |
|
273 | 271 |
|
274 | 272 | # Example configuration for intersphinx: refer to the Python standard library.
|
|
0 commit comments