|
20 | 20 | # If extensions (or modules to document with autodoc) are in another directory,
|
21 | 21 | # add these directories to sys.path here. If the directory is relative to the
|
22 | 22 | # documentation root, use os.path.abspath to make it absolute, like shown here.
|
23 |
| -#sys.path.insert(0, os.path.abspath('.')) |
| 23 | +# sys.path.insert(0, os.path.abspath('.')) |
24 | 24 |
|
25 | 25 | # -- General configuration ------------------------------------------------
|
26 | 26 |
|
27 | 27 | # If your documentation needs a minimal Sphinx version, state it here.
|
28 |
| -#needs_sphinx = '1.0' |
| 28 | +# needs_sphinx = '1.0' |
29 | 29 |
|
30 | 30 | # Add any Sphinx extension module names here, as strings. They can be
|
31 | 31 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
32 | 32 | # ones.
|
33 |
| -extensions = ['sphinx.ext.autodoc', |
34 |
| - 'sphinx.ext.autosummary', |
35 |
| - 'sphinx.ext.doctest', |
36 |
| - 'sphinx.ext.extlinks', |
37 |
| - 'sphinx.ext.todo', |
38 |
| - 'numpydoc', # used to parse numpy-style docstrings for autodoc |
39 |
| - 'IPython.sphinxext.ipython_directive', |
40 |
| - 'IPython.sphinxext.ipython_console_highlighting', |
41 |
| - 'sphinx.ext.intersphinx', |
42 |
| - 'sphinx.ext.coverage', |
43 |
| - 'sphinx.ext.imgmath', |
44 |
| - 'sphinx.ext.ifconfig', |
45 |
| - ] |
| 33 | +extensions = [ |
| 34 | + 'sphinx.ext.autodoc', |
| 35 | + 'sphinx.ext.autosummary', |
| 36 | + 'sphinx.ext.doctest', |
| 37 | + 'sphinx.ext.extlinks', |
| 38 | + 'sphinx.ext.todo', |
| 39 | + 'numpydoc', # used to parse numpy-style docstrings for autodoc |
| 40 | + 'IPython.sphinxext.ipython_directive', |
| 41 | + 'IPython.sphinxext.ipython_console_highlighting', |
| 42 | + 'sphinx.ext.intersphinx', |
| 43 | + 'sphinx.ext.coverage', |
| 44 | + 'sphinx.ext.imgmath', |
| 45 | + 'sphinx.ext.ifconfig', |
| 46 | +] |
46 | 47 |
|
47 | 48 | autosummary_generate = True
|
48 | 49 | numpydoc_show_class_members = False
|
49 | 50 | autodoc_default_flags = ['show-inheritance']
|
50 | 51 | autoclass_content = 'class'
|
51 | 52 |
|
52 |
| -intersphinx_mapping = {'python': ('https://docs.python.org/', None), |
53 |
| - 'pandas': ('http://pandas.pydata.org/pandas-docs/version/0.19.2/', None), |
54 |
| - 'numpy': ('http://docs.scipy.org/doc/numpy/', None), |
55 |
| - 'scipy': ('http://docs.scipy.org/doc/scipy/reference/', None), |
56 |
| - 'matplotlib': ('http://matplotlib.sourceforge.net/', None)} |
| 53 | +intersphinx_mapping = { |
| 54 | + 'python': ('https://docs.python.org/', None), |
| 55 | + 'pandas': ('http://pandas.pydata.org/pandas-docs/version/0.19.2/', None), |
| 56 | + 'numpy': ('http://docs.scipy.org/doc/numpy/', None), |
| 57 | + 'scipy': ('http://docs.scipy.org/doc/scipy/reference/', None), |
| 58 | + 'matplotlib': ('http://matplotlib.sourceforge.net/', None) |
| 59 | +} |
57 | 60 |
|
58 | 61 | # Add any paths that contain templates here, relative to this directory.
|
59 | 62 | templates_path = ['_templates']
|
|
64 | 67 | source_suffix = '.rst'
|
65 | 68 |
|
66 | 69 | # The encoding of source files.
|
67 |
| -#source_encoding = 'utf-8-sig' |
| 70 | +# source_encoding = 'utf-8-sig' |
68 | 71 |
|
69 | 72 | # The master toctree document.
|
70 | 73 | master_doc = 'index'
|
|
79 | 82 | # built documents.
|
80 | 83 | #
|
81 | 84 |
|
82 |
| -import swat |
| 85 | +import swat # noqa: W291 |
83 | 86 |
|
84 | 87 | # The short X.Y version.
|
85 | 88 | version = swat.__version__
|
|
95 | 98 |
|
96 | 99 | # There are two options for replacing |today|: either, you set today to some
|
97 | 100 | # non-false value, then it is used:
|
98 |
| -#today = '' |
| 101 | +# today = '' |
99 | 102 | # Else, today_fmt is used as the format for a strftime call.
|
100 |
| -#today_fmt = '%B %d, %Y' |
| 103 | +# today_fmt = '%B %d, %Y' |
101 | 104 |
|
102 | 105 | # List of patterns, relative to source directory, that match files and
|
103 | 106 | # directories to ignore when looking for source files.
|
104 | 107 | exclude_patterns = []
|
105 | 108 |
|
106 | 109 | # The reST default role (used for this markup: `text`) to use for all
|
107 | 110 | # documents.
|
108 |
| -#default_role = None |
| 111 | +# default_role = None |
109 | 112 |
|
110 | 113 | # If true, '()' will be appended to :func: etc. cross-reference text.
|
111 |
| -#add_function_parentheses = True |
| 114 | +# add_function_parentheses = True |
112 | 115 |
|
113 | 116 | # If true, the current module name will be prepended to all description
|
114 | 117 | # unit titles (such as .. function::).
|
115 |
| -#add_module_names = True |
| 118 | +# add_module_names = True |
116 | 119 |
|
117 | 120 | # If true, sectionauthor and moduleauthor directives will be shown in the
|
118 | 121 | # output. They are ignored by default.
|
119 |
| -#show_authors = False |
| 122 | +# show_authors = False |
120 | 123 |
|
121 | 124 | # The name of the Pygments (syntax highlighting) style to use.
|
122 | 125 | pygments_style = 'sphinx'
|
123 | 126 |
|
124 | 127 | # A list of ignored prefixes for module index sorting.
|
125 |
| -#modindex_common_prefix = [] |
| 128 | +# modindex_common_prefix = [] |
126 | 129 |
|
127 | 130 | # If true, keep warnings as "system message" paragraphs in the built documents.
|
128 |
| -#keep_warnings = False |
| 131 | +# keep_warnings = False |
129 | 132 |
|
130 | 133 | # If true, `todo` and `todoList` produce output, else they produce nothing.
|
131 | 134 | todo_include_todos = False
|
|
135 | 138 |
|
136 | 139 | # The theme to use for HTML and HTML Help pages. See the documentation for
|
137 | 140 | # a list of builtin themes.
|
138 |
| -import sphinx_rtd_theme |
| 141 | +import sphinx_rtd_theme # noqa: E402 |
139 | 142 |
|
140 | 143 | html_theme = 'sphinx_rtd_theme'
|
141 | 144 |
|
|
146 | 149 | # Theme options are theme-specific and customize the look and feel of a theme
|
147 | 150 | # further. For a list of options available for each theme, see the
|
148 | 151 | # documentation.
|
149 |
| -#html_theme_options = {} |
| 152 | +# html_theme_options = {} |
150 | 153 |
|
151 | 154 | # Add any paths that contain custom themes here, relative to this directory.
|
152 | 155 | html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
|
153 | 156 |
|
154 | 157 | # The name for this set of Sphinx documents. If None, it defaults to
|
155 | 158 | # "<project> v<release> documentation".
|
156 |
| -#html_title = None |
| 159 | +# html_title = None |
157 | 160 |
|
158 | 161 | # A shorter title for the navigation bar. Default is the same as html_title.
|
159 |
| -#html_short_title = None |
| 162 | +# html_short_title = None |
160 | 163 |
|
161 | 164 | # The name of an image file (relative to this directory) to place at the top
|
162 | 165 | # of the sidebar.
|
163 |
| -#html_logo = None |
| 166 | +# html_logo = None |
164 | 167 |
|
165 | 168 | # The name of an image file (within the static path) to use as favicon of the
|
166 | 169 | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
167 | 170 | # pixels large.
|
168 |
| -#html_favicon = None |
| 171 | +# html_favicon = None |
169 | 172 |
|
170 | 173 | # Add any paths that contain custom static files (such as style sheets) here,
|
171 | 174 | # relative to this directory. They are copied after the builtin static files,
|
|
175 | 178 | # Add any extra paths that contain custom files (such as robots.txt or
|
176 | 179 | # .htaccess) here, relative to this directory. These files are copied
|
177 | 180 | # directly to the root of the documentation.
|
178 |
| -#html_extra_path = [] |
| 181 | +# html_extra_path = [] |
179 | 182 |
|
180 | 183 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
181 | 184 | # using the given strftime format.
|
182 |
| -#html_last_updated_fmt = '%b %d, %Y' |
| 185 | +# html_last_updated_fmt = '%b %d, %Y' |
183 | 186 |
|
184 | 187 | # If true, SmartyPants will be used to convert quotes and dashes to
|
185 | 188 | # typographically correct entities.
|
186 |
| -#html_use_smartypants = True |
| 189 | +# html_use_smartypants = True |
187 | 190 |
|
188 | 191 | # Custom sidebar templates, maps document names to template names.
|
189 |
| -#html_sidebars = {} |
| 192 | +# html_sidebars = {} |
190 | 193 |
|
191 | 194 | # Additional templates that should be rendered to pages, maps page names to
|
192 | 195 | # template names.
|
193 |
| -#html_additional_pages = {} |
| 196 | +# html_additional_pages = {} |
194 | 197 |
|
195 | 198 | # If false, no module index is generated.
|
196 |
| -#html_domain_indices = True |
| 199 | +# html_domain_indices = True |
197 | 200 |
|
198 | 201 | # If false, no index is generated.
|
199 |
| -#html_use_index = True |
| 202 | +# html_use_index = True |
200 | 203 |
|
201 | 204 | # If true, the index is split into individual pages for each letter.
|
202 |
| -#html_split_index = False |
| 205 | +# html_split_index = False |
203 | 206 |
|
204 | 207 | # If true, links to the reST sources are added to the pages.
|
205 |
| -#html_show_sourcelink = True |
| 208 | +# html_show_sourcelink = True |
206 | 209 |
|
207 | 210 | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
208 |
| -#html_show_sphinx = True |
| 211 | +# html_show_sphinx = True |
209 | 212 |
|
210 | 213 | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
211 |
| -#html_show_copyright = True |
| 214 | +# html_show_copyright = True |
212 | 215 |
|
213 | 216 | # If true, an OpenSearch description file will be output, and all pages will
|
214 | 217 | # contain a <link> tag referring to it. The value of this option must be the
|
215 | 218 | # base URL from which the finished HTML is served.
|
216 |
| -#html_use_opensearch = '' |
| 219 | +# html_use_opensearch = '' |
217 | 220 |
|
218 | 221 | # This is the file name suffix for HTML files (e.g. ".xhtml").
|
219 |
| -#html_file_suffix = None |
| 222 | +# html_file_suffix = None |
220 | 223 |
|
221 | 224 | # Language to be used for generating the HTML full-text search index.
|
222 | 225 | # Sphinx supports the following languages:
|
223 | 226 | # 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'
|
224 | 227 | # 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr'
|
225 |
| -#html_search_language = 'en' |
| 228 | +# html_search_language = 'en' |
226 | 229 |
|
227 | 230 | # A dictionary with options for the search language support, empty by default.
|
228 | 231 | # Now only 'ja' uses this config value
|
229 |
| -#html_search_options = {'type': 'default'} |
| 232 | +# html_search_options = {'type': 'default'} |
230 | 233 |
|
231 | 234 | # The name of a javascript file (relative to the configuration directory) that
|
232 | 235 | # implements a search results scorer. If empty, the default will be used.
|
233 |
| -#html_search_scorer = 'scorer.js' |
| 236 | +# html_search_scorer = 'scorer.js' |
234 | 237 |
|
235 | 238 | # Output file base name for HTML help builder.
|
236 | 239 | htmlhelp_basename = 'SWATdoc'
|
237 | 240 |
|
238 | 241 | # -- Options for LaTeX output ---------------------------------------------
|
239 | 242 |
|
240 | 243 | latex_elements = {
|
241 |
| -# The paper size ('letterpaper' or 'a4paper'). |
242 |
| -#'papersize': 'letterpaper', |
| 244 | + # The paper size ('letterpaper' or 'a4paper'). |
| 245 | + # 'papersize': 'letterpaper', |
243 | 246 |
|
244 |
| -# The font size ('10pt', '11pt' or '12pt'). |
245 |
| -#'pointsize': '10pt', |
| 247 | + # The font size ('10pt', '11pt' or '12pt'). |
| 248 | + # 'pointsize': '10pt', |
246 | 249 |
|
247 |
| -# Additional stuff for the LaTeX preamble. |
248 |
| -#'preamble': '', |
| 250 | + # Additional stuff for the LaTeX preamble. |
| 251 | + # 'preamble': '', |
249 | 252 |
|
250 |
| -# Latex figure (float) alignment |
251 |
| -#'figure_align': 'htbp', |
| 253 | + # Latex figure (float) alignment |
| 254 | + # 'figure_align': 'htbp', |
252 | 255 | }
|
253 | 256 |
|
254 | 257 | # Grouping the document tree into LaTeX files. List of tuples
|
255 | 258 | # (source start file, target name, title,
|
256 | 259 | # author, documentclass [howto, manual, or own class]).
|
257 | 260 | latex_documents = [
|
258 |
| - (master_doc, 'SWAT.tex', 'SWAT Documentation', |
259 |
| - 'SAS', 'manual'), |
| 261 | + (master_doc, 'SWAT.tex', 'SWAT Documentation', 'SAS', 'manual'), |
260 | 262 | ]
|
261 | 263 |
|
262 | 264 | # The name of an image file (relative to this directory) to place at the top of
|
263 | 265 | # the title page.
|
264 |
| -#latex_logo = None |
| 266 | +# latex_logo = None |
265 | 267 |
|
266 | 268 | # For "manual" documents, if this is true, then toplevel headings are parts,
|
267 | 269 | # not chapters.
|
268 |
| -#latex_use_parts = False |
| 270 | +# latex_use_parts = False |
269 | 271 |
|
270 | 272 | # If true, show page references after internal links.
|
271 |
| -#latex_show_pagerefs = False |
| 273 | +# latex_show_pagerefs = False |
272 | 274 |
|
273 | 275 | # If true, show URL addresses after external links.
|
274 |
| -#latex_show_urls = False |
| 276 | +# latex_show_urls = False |
275 | 277 |
|
276 | 278 | # Documents to append as an appendix to all manuals.
|
277 |
| -#latex_appendices = [] |
| 279 | +# latex_appendices = [] |
278 | 280 |
|
279 | 281 | # If false, no module index is generated.
|
280 |
| -#latex_domain_indices = True |
| 282 | +# latex_domain_indices = True |
281 | 283 |
|
282 | 284 |
|
283 | 285 | # -- Options for manual page output ---------------------------------------
|
284 | 286 |
|
285 | 287 | # One entry per manual page. List of tuples
|
286 | 288 | # (source start file, name, description, authors, manual section).
|
287 | 289 | man_pages = [
|
288 |
| - (master_doc, 'swat', 'SWAT Documentation', |
289 |
| - [author], 1) |
| 290 | + (master_doc, 'swat', 'SWAT Documentation', [author], 1) |
290 | 291 | ]
|
291 | 292 |
|
292 | 293 | # If true, show URL addresses after external links.
|
293 |
| -#man_show_urls = False |
| 294 | +# man_show_urls = False |
294 | 295 |
|
295 | 296 |
|
296 | 297 | # -- Options for Texinfo output -------------------------------------------
|
|
299 | 300 | # (source start file, target name, title, author,
|
300 | 301 | # dir menu entry, description, category)
|
301 | 302 | texinfo_documents = [
|
302 |
| - (master_doc, 'SWAT', 'SWAT Documentation', |
303 |
| - author, 'SWAT', 'One line description of project.', |
304 |
| - 'Miscellaneous'), |
| 303 | + (master_doc, 'SWAT', 'SWAT Documentation', |
| 304 | + author, 'SWAT', 'One line description of project.', |
| 305 | + 'Miscellaneous'), |
305 | 306 | ]
|
306 | 307 |
|
307 | 308 | # Documents to append as an appendix to all manuals.
|
308 |
| -#texinfo_appendices = [] |
| 309 | +# texinfo_appendices = [] |
309 | 310 |
|
310 | 311 | # If false, no module index is generated.
|
311 |
| -#texinfo_domain_indices = True |
| 312 | +# texinfo_domain_indices = True |
312 | 313 |
|
313 | 314 | # How to display URL addresses: 'footnote', 'no', or 'inline'.
|
314 |
| -#texinfo_show_urls = 'footnote' |
| 315 | +# texinfo_show_urls = 'footnote' |
315 | 316 |
|
316 | 317 | # If true, do not generate a @detailmenu in the "Top" node's menu.
|
317 |
| -#texinfo_no_detailmenu = False |
| 318 | +# texinfo_no_detailmenu = False |
0 commit comments