|
15 | 15 | import os |
16 | 16 | import sys |
17 | 17 | import sphinx_bootstrap_theme |
18 | | -from sphinx_gallery.sorting import ExplicitOrder, FileNameSortKey |
19 | 18 | import openml |
20 | 19 |
|
21 | 20 |
|
|
27 | 26 | # If extensions (or modules to document with autodoc) are in another directory, |
28 | 27 | # add these directories to sys.path here. If the directory is relative to the |
29 | 28 | # documentation root, use os.path.abspath to make it absolute, like shown here. |
30 | | -#sys.path.insert(0, os.path.abspath('.')# ) |
| 29 | +# sys.path.insert(0, os.path.abspath('.')# ) |
31 | 30 |
|
32 | 31 | sys.path.insert(0, os.path.join(os.path.dirname(__file__), '..')) |
33 | 32 | sys.path.insert(0, os.path.join(os.path.dirname(__file__), '..', '..')) |
34 | 33 |
|
35 | 34 | # -- General configuration ------------------------------------------------ |
36 | 35 |
|
37 | 36 | # If your documentation needs a minimal Sphinx version, state it here. |
38 | | -#needs_sphinx = '1.0' |
| 37 | +# needs_sphinx = '1.0' |
39 | 38 |
|
40 | | -# Add any Sphinx extension module names here, as strings. They can be |
41 | | -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
42 | | -# ones. |
| 39 | +# Add any Sphinx extension module names here, as strings. They can be |
| 40 | +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
| 41 | +# ones. |
43 | 42 | extensions = [ |
44 | 43 | 'sphinx.ext.autodoc', |
45 | 44 | 'sphinx.ext.autosummary', |
|
64 | 63 | source_suffix = '.rst' |
65 | 64 |
|
66 | 65 | # The encoding of source files. |
67 | | -#source_encoding = 'utf-8-sig' |
| 66 | +# source_encoding = 'utf-8-sig' |
68 | 67 |
|
69 | 68 | # The master toctree document. |
70 | 69 | master_doc = 'index' |
|
87 | 86 |
|
88 | 87 | # The language for content autogenerated by Sphinx. Refer to documentation |
89 | 88 | # for a list of supported languages. |
90 | | -#language = None |
| 89 | +# language = None |
91 | 90 |
|
92 | 91 | # There are two options for replacing |today|: either, you set today to some |
93 | 92 | # non-false value, then it is used: |
94 | | -#today = '' |
| 93 | +# today = '' |
95 | 94 | # Else, today_fmt is used as the format for a strftime call. |
96 | | -#today_fmt = '%B %d, %Y' |
| 95 | +# today_fmt = '%B %d, %Y' |
97 | 96 |
|
98 | 97 | # List of patterns, relative to source directory, that match files and |
99 | 98 | # directories to ignore when looking for source files. |
100 | 99 | exclude_patterns = ['_build', '_templates', '_static'] |
101 | 100 |
|
102 | 101 | # The reST default role (used for this markup: `text`) to use for all |
103 | 102 | # documents. |
104 | | -#default_role = None |
| 103 | +# default_role = None |
105 | 104 |
|
106 | 105 | # If true, '()' will be appended to :func: etc. cross-reference text. |
107 | | -#add_function_parentheses = True |
| 106 | +# add_function_parentheses = True |
108 | 107 |
|
109 | 108 | # If true, the current module name will be prepended to all description |
110 | 109 | # unit titles (such as .. function::). |
111 | | -#add_module_names = True |
| 110 | +# add_module_names = True |
112 | 111 |
|
113 | 112 | # If true, sectionauthor and moduleauthor directives will be shown in the |
114 | 113 | # output. They are ignored by default. |
115 | | -#show_authors = False |
| 114 | +# show_authors = False |
116 | 115 |
|
117 | 116 | # The name of the Pygments (syntax highlighting) style to use. |
118 | 117 | pygments_style = 'sphinx' |
119 | 118 |
|
120 | 119 | # A list of ignored prefixes for module index sorting. |
121 | | -#modindex_common_prefix = [] |
| 120 | +# modindex_common_prefix = [] |
122 | 121 |
|
123 | 122 | # If true, keep warnings as "system message" paragraphs in the built documents. |
124 | | -#keep_warnings = False |
| 123 | +# keep_warnings = False |
125 | 124 |
|
126 | 125 |
|
127 | 126 | # -- Options for HTML output ---------------------------------------------- |
|
135 | 134 | 'navbar_title': "OpenML", |
136 | 135 |
|
137 | 136 | # Tab name for entire site. (Default: "Site") |
138 | | - #'navbar_site_name': "Site", |
| 137 | + # 'navbar_site_name': "Site", |
139 | 138 |
|
140 | 139 | # A list of tuples containting pages to link to. The value should |
141 | 140 | # be in the form [(name, page), ..] |
|
198 | 197 |
|
199 | 198 | # The name for this set of Sphinx documents. If None, it defaults to |
200 | 199 | # "<project> v<release> documentation". |
201 | | -#html_title = None |
| 200 | +# html_title = None |
202 | 201 |
|
203 | 202 | # A shorter title for the navigation bar. Default is the same as html_title. |
204 | | -#html_short_title = None |
| 203 | +# html_short_title = None |
205 | 204 |
|
206 | 205 | # The name of an image file (relative to this directory) to place at the top |
207 | 206 | # of the sidebar. |
208 | | -#html_logo = None |
| 207 | +# html_logo = None |
209 | 208 |
|
210 | 209 | # The name of an image file (within the static path) to use as favicon of the |
211 | 210 | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 |
212 | 211 | # pixels large. |
213 | | -#html_favicon = None |
| 212 | +# html_favicon = None |
214 | 213 |
|
215 | 214 | # Add any paths that contain custom static files (such as style sheets) here, |
216 | 215 | # relative to this directory. They are copied after the builtin static files, |
|
220 | 219 | # Add any extra paths that contain custom files (such as robots.txt or |
221 | 220 | # .htaccess) here, relative to this directory. These files are copied |
222 | 221 | # directly to the root of the documentation. |
223 | | -#html_extra_path = [] |
| 222 | +# html_extra_path = [] |
224 | 223 |
|
225 | 224 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
226 | 225 | # using the given strftime format. |
227 | | -#html_last_updated_fmt = '%b %d, %Y' |
| 226 | +# html_last_updated_fmt = '%b %d, %Y' |
228 | 227 |
|
229 | 228 | # If true, SmartyPants will be used to convert quotes and dashes to |
230 | 229 | # typographically correct entities. |
231 | | -#html_use_smartypants = True |
| 230 | +# html_use_smartypants = True |
232 | 231 |
|
233 | 232 | # Custom sidebar templates, maps document names to template names. |
234 | 233 | html_sidebars = {'**': ['localtoc.html']} |
235 | 234 |
|
236 | 235 | # Additional templates that should be rendered to pages, maps page names to |
237 | 236 | # template names. |
238 | | -#html_additional_pages = {} |
| 237 | +# html_additional_pages = {} |
239 | 238 |
|
240 | 239 | # If false, no module index is generated. |
241 | | -#html_domain_indices = True |
| 240 | +# html_domain_indices = True |
242 | 241 |
|
243 | 242 | # If false, no index is generated. |
244 | | -#html_use_index = True |
| 243 | +# html_use_index = True |
245 | 244 |
|
246 | 245 | # If true, the index is split into individual pages for each letter. |
247 | | -#html_split_index = False |
| 246 | +# html_split_index = False |
248 | 247 |
|
249 | 248 | # If true, links to the reST sources are added to the pages. |
250 | | -#html_show_sourcelink = True |
| 249 | +# html_show_sourcelink = True |
251 | 250 |
|
252 | 251 | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. |
253 | | -#html_show_sphinx = True |
| 252 | +# html_show_sphinx = True |
254 | 253 |
|
255 | 254 | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. |
256 | | -#html_show_copyright = True |
| 255 | +# html_show_copyright = True |
257 | 256 |
|
258 | 257 | # If true, an OpenSearch description file will be output, and all pages will |
259 | 258 | # contain a <link> tag referring to it. The value of this option must be the |
260 | 259 | # base URL from which the finished HTML is served. |
261 | | -#html_use_opensearch = '' |
| 260 | +# html_use_opensearch = '' |
262 | 261 |
|
263 | 262 | # This is the file name suffix for HTML files (e.g. ".xhtml"). |
264 | | -#html_file_suffix = None |
| 263 | +# html_file_suffix = None |
265 | 264 |
|
266 | 265 | # Output file base name for HTML help builder. |
267 | 266 | htmlhelp_basename = 'OpenMLdoc' |
|
271 | 270 |
|
272 | 271 | latex_elements = { |
273 | 272 | # The paper size ('letterpaper' or 'a4paper'). |
274 | | - #'papersize': 'letterpaper', |
| 273 | + # 'papersize': 'letterpaper', |
275 | 274 |
|
276 | 275 | # The font size ('10pt', '11pt' or '12pt'). |
277 | | - #'pointsize': '10pt', |
| 276 | + # 'pointsize': '10pt', |
278 | 277 |
|
279 | 278 | # Additional stuff for the LaTeX preamble. |
280 | | - #'preamble': '', |
| 279 | + # 'preamble': '', |
281 | 280 | } |
282 | 281 |
|
283 | 282 | # Grouping the document tree into LaTeX files. List of tuples |
|
288 | 287 |
|
289 | 288 | # The name of an image file (relative to this directory) to place at the top of |
290 | 289 | # the title page. |
291 | | -#latex_logo = None |
| 290 | +# latex_logo = None |
292 | 291 |
|
293 | 292 | # For "manual" documents, if this is true, then toplevel headings are parts, |
294 | 293 | # not chapters. |
295 | | -#latex_use_parts = False |
| 294 | +# latex_use_parts = False |
296 | 295 |
|
297 | 296 | # If true, show page references after internal links. |
298 | | -#latex_show_pagerefs = False |
| 297 | +# latex_show_pagerefs = False |
299 | 298 |
|
300 | 299 | # If true, show URL addresses after external links. |
301 | | -#latex_show_urls = False |
| 300 | +# latex_show_urls = False |
302 | 301 |
|
303 | 302 | # Documents to append as an appendix to all manuals. |
304 | | -#latex_appendices = [] |
| 303 | +# latex_appendices = [] |
305 | 304 |
|
306 | 305 | # If false, no module index is generated. |
307 | | -#latex_domain_indices = True |
| 306 | +# latex_domain_indices = True |
308 | 307 |
|
309 | 308 |
|
310 | 309 | # -- Options for manual page output --------------------------------------- |
|
317 | 316 | ] |
318 | 317 |
|
319 | 318 | # If true, show URL addresses after external links. |
320 | | -#man_show_urls = False |
| 319 | +# man_show_urls = False |
321 | 320 |
|
322 | 321 |
|
323 | 322 | # -- Options for Texinfo output ------------------------------------------- |
|
332 | 331 | ] |
333 | 332 |
|
334 | 333 | # Documents to append as an appendix to all manuals. |
335 | | -#texinfo_appendices = [] |
| 334 | +# texinfo_appendices = [] |
336 | 335 |
|
337 | 336 | # If false, no module index is generated. |
338 | | -#texinfo_domain_indices = True |
| 337 | +# texinfo_domain_indices = True |
339 | 338 |
|
340 | 339 | # How to display URL addresses: 'footnote', 'no', or 'inline'. |
341 | | -#texinfo_show_urls = 'footnote' |
| 340 | +# texinfo_show_urls = 'footnote' |
342 | 341 |
|
343 | 342 | # If true, do not generate a @detailmenu in the "Top" node's menu. |
344 | | -#texinfo_no_detailmenu = False |
| 343 | +# texinfo_no_detailmenu = False |
345 | 344 |
|
346 | | -# prefix each section label with the name of the document it is in, in order to avoid |
347 | | -# ambiguity when there are multiple same section labels in different documents. |
| 345 | +# prefix each section label with the name of the document it is in, |
| 346 | +# in order to avoid ambiguity when there are multiple same section |
| 347 | +# labels in different documents. |
348 | 348 | autosectionlabel_prefix_document = True |
349 | 349 | # Sphinx-gallery configuration. |
350 | 350 | sphinx_gallery_conf = { |
|
356 | 356 | 'gallery_dirs': 'examples', |
357 | 357 | # compile execute examples in the examples dir |
358 | 358 | 'filename_pattern': '.*example.py$|.*tutorial.py$', |
359 | | - #TODO: fix back/forward references for the examples. |
| 359 | + # TODO: fix back/forward references for the examples. |
360 | 360 | } |
0 commit comments