|
1 |
| -# -*- coding: utf-8 -*- |
2 | 1 | #
|
3 | 2 | # mir_eval documentation build configuration file, created by
|
4 | 3 | # sphinx-quickstart on Thu May 8 15:55:45 2014.
|
|
14 | 13 |
|
15 | 14 | import sys
|
16 | 15 | import os
|
17 |
| -sys.path.insert(0, os.path.abspath('..')) |
| 16 | + |
| 17 | +sys.path.insert(0, os.path.abspath("..")) |
18 | 18 |
|
19 | 19 |
|
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 | 33 | extensions = [
|
34 |
| - 'sphinx.ext.autodoc', |
35 |
| - 'sphinx.ext.imgmath', |
36 |
| - 'numpydoc', |
| 34 | + "sphinx.ext.autodoc", |
| 35 | + "sphinx.ext.imgmath", |
| 36 | + "numpydoc", |
37 | 37 | ]
|
38 | 38 |
|
39 | 39 | # Add any paths that contain templates here, relative to this directory.
|
40 |
| -templates_path = ['_templates'] |
| 40 | +templates_path = ["_templates"] |
41 | 41 |
|
42 | 42 | # The suffix of source filenames.
|
43 |
| -source_suffix = '.rst' |
| 43 | +source_suffix = ".rst" |
44 | 44 |
|
45 | 45 | # The encoding of source files.
|
46 |
| -#source_encoding = 'utf-8-sig' |
| 46 | +# source_encoding = 'utf-8-sig' |
47 | 47 |
|
48 | 48 | # The master toctree document.
|
49 |
| -master_doc = 'index' |
| 49 | +master_doc = "index" |
50 | 50 |
|
51 | 51 | # General information about the project.
|
52 |
| -project = 'mir_eval' |
53 |
| -copyright = '2014, Colin Raffel et al.' |
| 52 | +project = "mir_eval" |
| 53 | +copyright = "2014, Colin Raffel et al." |
54 | 54 |
|
55 | 55 | # The version info for the project you're documenting, acts as replacement for
|
56 | 56 | # |version| and |release|, also used in various other places throughout the
|
57 | 57 | # built documents.
|
58 | 58 | #
|
59 | 59 | # The short X.Y version.
|
60 |
| -version = '0.7' |
| 60 | +version = "0.7" |
61 | 61 | # The full version, including alpha/beta/rc tags.
|
62 |
| -release = '0.7' |
| 62 | +release = "0.7" |
63 | 63 |
|
64 | 64 | # The language for content autogenerated by Sphinx. Refer to documentation
|
65 | 65 | # for a list of supported languages.
|
66 |
| -#language = None |
| 66 | +# language = None |
67 | 67 |
|
68 | 68 | # There are two options for replacing |today|: either, you set today to some
|
69 | 69 | # non-false value, then it is used:
|
70 |
| -#today = '' |
| 70 | +# today = '' |
71 | 71 | # Else, today_fmt is used as the format for a strftime call.
|
72 |
| -#today_fmt = '%B %d, %Y' |
| 72 | +# today_fmt = '%B %d, %Y' |
73 | 73 |
|
74 | 74 | # List of patterns, relative to source directory, that match files and
|
75 | 75 | # directories to ignore when looking for source files.
|
76 |
| -exclude_patterns = ['_build'] |
| 76 | +exclude_patterns = ["_build"] |
77 | 77 |
|
78 | 78 | # The reST default role (used for this markup: `text`) to use for all
|
79 | 79 | # documents.
|
80 |
| -#default_role = None |
| 80 | +# default_role = None |
81 | 81 |
|
82 | 82 | # If true, '()' will be appended to :func: etc. cross-reference text.
|
83 |
| -#add_function_parentheses = True |
| 83 | +# add_function_parentheses = True |
84 | 84 |
|
85 | 85 | # If true, the current module name will be prepended to all description
|
86 | 86 | # unit titles (such as .. function::).
|
87 |
| -#add_module_names = True |
| 87 | +# add_module_names = True |
88 | 88 |
|
89 | 89 | # If true, sectionauthor and moduleauthor directives will be shown in the
|
90 | 90 | # output. They are ignored by default.
|
91 |
| -#show_authors = False |
| 91 | +# show_authors = False |
92 | 92 |
|
93 | 93 | # The name of the Pygments (syntax highlighting) style to use.
|
94 |
| -pygments_style = 'sphinx' |
| 94 | +pygments_style = "sphinx" |
95 | 95 |
|
96 | 96 | # A list of ignored prefixes for module index sorting.
|
97 |
| -#modindex_common_prefix = [] |
| 97 | +# modindex_common_prefix = [] |
98 | 98 |
|
99 | 99 | # If true, keep warnings as "system message" paragraphs in the built documents.
|
100 |
| -#keep_warnings = False |
| 100 | +# keep_warnings = False |
101 | 101 |
|
102 | 102 |
|
103 | 103 | # -- Options for HTML output ----------------------------------------------
|
104 | 104 |
|
105 | 105 | # The theme to use for HTML and HTML Help pages. See the documentation for
|
106 | 106 | # a list of builtin themes.
|
107 |
| -html_theme = 'default' |
| 107 | +html_theme = "default" |
108 | 108 |
|
109 | 109 | # Theme options are theme-specific and customize the look and feel of a theme
|
110 | 110 | # further. For a list of options available for each theme, see the
|
111 | 111 | # documentation.
|
112 |
| -#html_theme_options = {} |
| 112 | +# html_theme_options = {} |
113 | 113 |
|
114 | 114 | # Add any paths that contain custom themes here, relative to this directory.
|
115 |
| -#html_theme_path = [] |
| 115 | +# html_theme_path = [] |
116 | 116 |
|
117 | 117 | # The name for this set of Sphinx documents. If None, it defaults to
|
118 | 118 | # "<project> v<release> documentation".
|
119 |
| -#html_title = None |
| 119 | +# html_title = None |
120 | 120 |
|
121 | 121 | # A shorter title for the navigation bar. Default is the same as html_title.
|
122 |
| -#html_short_title = None |
| 122 | +# html_short_title = None |
123 | 123 |
|
124 | 124 | # The name of an image file (relative to this directory) to place at the top
|
125 | 125 | # of the sidebar.
|
126 |
| -#html_logo = None |
| 126 | +# html_logo = None |
127 | 127 |
|
128 | 128 | # The name of an image file (within the static path) to use as favicon of the
|
129 | 129 | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
130 | 130 | # pixels large.
|
131 |
| -#html_favicon = None |
| 131 | +# html_favicon = None |
132 | 132 |
|
133 | 133 | # Add any paths that contain custom static files (such as style sheets) here,
|
134 | 134 | # relative to this directory. They are copied after the builtin static files,
|
135 | 135 | # so a file named "default.css" will overwrite the builtin "default.css".
|
136 |
| -html_static_path = ['_static'] |
| 136 | +html_static_path = ["_static"] |
137 | 137 |
|
138 | 138 | # Add any extra paths that contain custom files (such as robots.txt or
|
139 | 139 | # .htaccess) here, relative to this directory. These files are copied
|
140 | 140 | # directly to the root of the documentation.
|
141 |
| -#html_extra_path = [] |
| 141 | +# html_extra_path = [] |
142 | 142 |
|
143 | 143 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
144 | 144 | # using the given strftime format.
|
145 |
| -#html_last_updated_fmt = '%b %d, %Y' |
| 145 | +# html_last_updated_fmt = '%b %d, %Y' |
146 | 146 |
|
147 | 147 | # If true, SmartyPants will be used to convert quotes and dashes to
|
148 | 148 | # typographically correct entities.
|
149 |
| -#html_use_smartypants = True |
| 149 | +# html_use_smartypants = True |
150 | 150 |
|
151 | 151 | # Custom sidebar templates, maps document names to template names.
|
152 |
| -#html_sidebars = {} |
| 152 | +# html_sidebars = {} |
153 | 153 |
|
154 | 154 | # Additional templates that should be rendered to pages, maps page names to
|
155 | 155 | # template names.
|
156 |
| -#html_additional_pages = {} |
| 156 | +# html_additional_pages = {} |
157 | 157 |
|
158 | 158 | # If false, no module index is generated.
|
159 |
| -#html_domain_indices = True |
| 159 | +# html_domain_indices = True |
160 | 160 |
|
161 | 161 | # If false, no index is generated.
|
162 |
| -#html_use_index = True |
| 162 | +# html_use_index = True |
163 | 163 |
|
164 | 164 | # If true, the index is split into individual pages for each letter.
|
165 |
| -#html_split_index = False |
| 165 | +# html_split_index = False |
166 | 166 |
|
167 | 167 | # If true, links to the reST sources are added to the pages.
|
168 |
| -#html_show_sourcelink = True |
| 168 | +# html_show_sourcelink = True |
169 | 169 |
|
170 | 170 | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
171 |
| -#html_show_sphinx = True |
| 171 | +# html_show_sphinx = True |
172 | 172 |
|
173 | 173 | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
174 |
| -#html_show_copyright = True |
| 174 | +# html_show_copyright = True |
175 | 175 |
|
176 | 176 | # If true, an OpenSearch description file will be output, and all pages will
|
177 | 177 | # contain a <link> tag referring to it. The value of this option must be the
|
178 | 178 | # base URL from which the finished HTML is served.
|
179 |
| -#html_use_opensearch = '' |
| 179 | +# html_use_opensearch = '' |
180 | 180 |
|
181 | 181 | # This is the file name suffix for HTML files (e.g. ".xhtml").
|
182 |
| -#html_file_suffix = None |
| 182 | +# html_file_suffix = None |
183 | 183 |
|
184 | 184 | # Output file base name for HTML help builder.
|
185 |
| -htmlhelp_basename = 'mir_evaldoc' |
| 185 | +htmlhelp_basename = "mir_evaldoc" |
186 | 186 |
|
187 | 187 |
|
188 | 188 | # -- Options for LaTeX output ---------------------------------------------
|
189 | 189 |
|
190 | 190 | latex_elements = {
|
191 |
| -# The paper size ('letterpaper' or 'a4paper'). |
192 |
| -#'papersize': 'letterpaper', |
193 |
| - |
194 |
| -# The font size ('10pt', '11pt' or '12pt'). |
195 |
| -#'pointsize': '10pt', |
196 |
| - |
197 |
| -# Additional stuff for the LaTeX preamble. |
198 |
| -#'preamble': '', |
| 191 | + # The paper size ('letterpaper' or 'a4paper'). |
| 192 | + #'papersize': 'letterpaper', |
| 193 | + # The font size ('10pt', '11pt' or '12pt'). |
| 194 | + #'pointsize': '10pt', |
| 195 | + # Additional stuff for the LaTeX preamble. |
| 196 | + #'preamble': '', |
199 | 197 | }
|
200 | 198 |
|
201 | 199 | # Grouping the document tree into LaTeX files. List of tuples
|
202 | 200 | # (source start file, target name, title,
|
203 | 201 | # author, documentclass [howto, manual, or own class]).
|
204 | 202 | latex_documents = [
|
205 |
| - ('index', 'mir_eval.tex', 'mir\\_eval Documentation', |
206 |
| - 'Colin Raffel et al.', 'manual'), |
| 203 | + ( |
| 204 | + "index", |
| 205 | + "mir_eval.tex", |
| 206 | + "mir\\_eval Documentation", |
| 207 | + "Colin Raffel et al.", |
| 208 | + "manual", |
| 209 | + ), |
207 | 210 | ]
|
208 | 211 |
|
209 | 212 | # The name of an image file (relative to this directory) to place at the top of
|
210 | 213 | # the title page.
|
211 |
| -#latex_logo = None |
| 214 | +# latex_logo = None |
212 | 215 |
|
213 | 216 | # For "manual" documents, if this is true, then toplevel headings are parts,
|
214 | 217 | # not chapters.
|
215 |
| -#latex_use_parts = False |
| 218 | +# latex_use_parts = False |
216 | 219 |
|
217 | 220 | # If true, show page references after internal links.
|
218 |
| -#latex_show_pagerefs = False |
| 221 | +# latex_show_pagerefs = False |
219 | 222 |
|
220 | 223 | # If true, show URL addresses after external links.
|
221 |
| -#latex_show_urls = False |
| 224 | +# latex_show_urls = False |
222 | 225 |
|
223 | 226 | # Documents to append as an appendix to all manuals.
|
224 |
| -#latex_appendices = [] |
| 227 | +# latex_appendices = [] |
225 | 228 |
|
226 | 229 | # If false, no module index is generated.
|
227 |
| -#latex_domain_indices = True |
| 230 | +# latex_domain_indices = True |
228 | 231 |
|
229 | 232 |
|
230 | 233 | # -- Options for manual page output ---------------------------------------
|
231 | 234 |
|
232 | 235 | # One entry per manual page. List of tuples
|
233 | 236 | # (source start file, name, description, authors, manual section).
|
234 | 237 | man_pages = [
|
235 |
| - ('index', 'mir_eval', 'mir_eval Documentation', |
236 |
| - ['Colin Raffel et al.'], 1) |
| 238 | + ("index", "mir_eval", "mir_eval Documentation", ["Colin Raffel et al."], 1) |
237 | 239 | ]
|
238 | 240 |
|
239 | 241 | # If true, show URL addresses after external links.
|
240 |
| -#man_show_urls = False |
| 242 | +# man_show_urls = False |
241 | 243 |
|
242 | 244 |
|
243 | 245 | # -- Options for Texinfo output -------------------------------------------
|
|
246 | 248 | # (source start file, target name, title, author,
|
247 | 249 | # dir menu entry, description, category)
|
248 | 250 | texinfo_documents = [
|
249 |
| - ('index', 'mir_eval', 'mir_eval Documentation', |
250 |
| - 'Colin Raffel et al.', 'mir_eval', 'One line description of project.', |
251 |
| - 'Miscellaneous'), |
| 251 | + ( |
| 252 | + "index", |
| 253 | + "mir_eval", |
| 254 | + "mir_eval Documentation", |
| 255 | + "Colin Raffel et al.", |
| 256 | + "mir_eval", |
| 257 | + "One line description of project.", |
| 258 | + "Miscellaneous", |
| 259 | + ), |
252 | 260 | ]
|
253 | 261 |
|
254 | 262 | # Documents to append as an appendix to all manuals.
|
255 |
| -#texinfo_appendices = [] |
| 263 | +# texinfo_appendices = [] |
256 | 264 |
|
257 | 265 | # If false, no module index is generated.
|
258 |
| -#texinfo_domain_indices = True |
| 266 | +# texinfo_domain_indices = True |
259 | 267 |
|
260 | 268 | # How to display URL addresses: 'footnote', 'no', or 'inline'.
|
261 |
| -#texinfo_show_urls = 'footnote' |
| 269 | +# texinfo_show_urls = 'footnote' |
262 | 270 |
|
263 | 271 | # If true, do not generate a @detailmenu in the "Top" node's menu.
|
264 |
| -#texinfo_no_detailmenu = False |
| 272 | +# texinfo_no_detailmenu = False |
265 | 273 |
|
266 |
| -autodoc_member_order = 'bysource' |
| 274 | +autodoc_member_order = "bysource" |
0 commit comments