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