Skip to content

Commit 4cc790b

Browse files
committed
style: Run ruff format
1 parent d28dc88 commit 4cc790b

31 files changed

Lines changed: 4043 additions & 3510 deletions

docs/conf.py

Lines changed: 84 additions & 85 deletions
Original file line numberDiff line numberDiff line change
@@ -15,35 +15,34 @@
1515
# If extensions (or modules to document with autodoc) are in another directory,
1616
# add these directories to sys.path here. If the directory is relative to the
1717
# 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(".."))
1919
import musicbrainzngs
2020
from musicbrainzngs.musicbrainz import _version
2121

2222
# -- General configuration -----------------------------------------------------
2323

2424
# If your documentation needs a minimal Sphinx version, state it here.
25-
#needs_sphinx = '1.0'
25+
# needs_sphinx = '1.0'
2626

2727
# Add any Sphinx extension module names here, as strings. They can be extensions
2828
# 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"]
3130

3231
# Add any paths that contain templates here, relative to this directory.
33-
templates_path = ['_templates']
32+
templates_path = ["_templates"]
3433

3534
# The suffix of source filenames.
36-
source_suffix = '.rst'
35+
source_suffix = ".rst"
3736

3837
# The encoding of source files.
39-
#source_encoding = 'utf-8-sig'
38+
# source_encoding = 'utf-8-sig'
4039

4140
# The master toctree document.
42-
master_doc = 'index'
41+
master_doc = "index"
4342

4443
# 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"
4746

4847
# The version info for the project you're documenting, acts as replacement for
4948
# |version| and |release|, also used in various other places throughout the
@@ -56,54 +55,54 @@
5655

5756
# The language for content autogenerated by Sphinx. Refer to documentation
5857
# for a list of supported languages.
59-
#language = None
58+
# language = None
6059

6160
# There are two options for replacing |today|: either, you set today to some
6261
# non-false value, then it is used:
63-
#today = ''
62+
# today = ''
6463
# Else, today_fmt is used as the format for a strftime call.
65-
#today_fmt = '%B %d, %Y'
64+
# today_fmt = '%B %d, %Y'
6665

6766
# List of patterns, relative to source directory, that match files and
6867
# directories to ignore when looking for source files.
69-
exclude_patterns = ['_build']
68+
exclude_patterns = ["_build"]
7069

7170
# The reST default role (used for this markup: `text`) to use for all documents.
72-
#default_role = None
71+
# default_role = None
7372

7473
# If true, '()' will be appended to :func: etc. cross-reference text.
75-
#add_function_parentheses = True
74+
# add_function_parentheses = True
7675

7776
# If true, the current module name will be prepended to all description
7877
# unit titles (such as .. function::).
79-
#add_module_names = True
78+
# add_module_names = True
8079

8180
# If true, sectionauthor and moduleauthor directives will be shown in the
8281
# output. They are ignored by default.
83-
#show_authors = False
82+
# show_authors = False
8483

8584
# The name of the Pygments (syntax highlighting) style to use.
86-
pygments_style = 'sphinx'
85+
pygments_style = "sphinx"
8786

8887
# A list of ignored prefixes for module index sorting.
89-
#modindex_common_prefix = []
88+
# modindex_common_prefix = []
9089

9190
extlinks = {
92-
'musicbrainz': ('https://musicbrainz.org/doc/%s', '%s'),
91+
"musicbrainz": ("https://musicbrainz.org/doc/%s", "%s"),
9392
}
9493

9594
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),
9998
}
10099

101100

102101
# -- Options for HTML output ---------------------------------------------------
103102

104103
# The theme to use for HTML and HTML Help pages. See the documentation for
105104
# a list of builtin themes.
106-
html_theme = 'default'
105+
html_theme = "default"
107106

108107
# force default theme on readthedocs
109108
html_style = "/default.css"
@@ -112,143 +111,137 @@
112111
# further. For a list of options available for each theme, see the
113112
# documentation.
114113
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+
}
130129

131130
# Add any paths that contain custom themes here, relative to this directory.
132-
#html_theme_path = []
131+
# html_theme_path = []
133132

134133
# The name for this set of Sphinx documents. If None, it defaults to
135134
# "<project> v<release> documentation".
136-
#html_title = None
135+
# html_title = None
137136

138137
# A shorter title for the navigation bar. Default is the same as html_title.
139-
#html_short_title = None
138+
# html_short_title = None
140139

141140
# The name of an image file (relative to this directory) to place at the top
142141
# of the sidebar.
143-
#html_logo = None
142+
# html_logo = None
144143

145144
# The name of an image file (within the static path) to use as favicon of the
146145
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
147146
# pixels large.
148-
#html_favicon = None
147+
# html_favicon = None
149148

150149
# Add any paths that contain custom static files (such as style sheets) here,
151150
# relative to this directory. They are copied after the builtin static files,
152151
# so a file named "default.css" will overwrite the builtin "default.css".
153-
#html_static_path = ['_static']
152+
# html_static_path = ['_static']
154153

155154
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
156155
# using the given strftime format.
157-
html_last_updated_fmt = '%b %d, %Y'
156+
html_last_updated_fmt = "%b %d, %Y"
158157

159158
# If true, SmartyPants will be used to convert quotes and dashes to
160159
# typographically correct entities.
161-
#html_use_smartypants = True
160+
# html_use_smartypants = True
162161

163162
# Custom sidebar templates, maps document names to template names.
164-
#html_sidebars = {}
163+
# html_sidebars = {}
165164

166165
# Additional templates that should be rendered to pages, maps page names to
167166
# template names.
168-
#html_additional_pages = {}
167+
# html_additional_pages = {}
169168

170169
# If false, no module index is generated.
171-
#html_domain_indices = True
170+
# html_domain_indices = True
172171

173172
# If false, no index is generated.
174-
#html_use_index = True
173+
# html_use_index = True
175174

176175
# If true, the index is split into individual pages for each letter.
177-
#html_split_index = False
176+
# html_split_index = False
178177

179178
# If true, links to the reST sources are added to the pages.
180179
html_show_sourcelink = False
181180

182181
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
183-
#html_show_sphinx = True
182+
# html_show_sphinx = True
184183

185184
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
186-
#html_show_copyright = True
185+
# html_show_copyright = True
187186

188187
# If true, an OpenSearch description file will be output, and all pages will
189188
# contain a <link> tag referring to it. The value of this option must be the
190189
# base URL from which the finished HTML is served.
191-
#html_use_opensearch = ''
190+
# html_use_opensearch = ''
192191

193192
# This is the file name suffix for HTML files (e.g. ".xhtml").
194-
#html_file_suffix = None
193+
# html_file_suffix = None
195194

196195
# Output file base name for HTML help builder.
197-
htmlhelp_basename = 'musicbrainzngsdoc'
196+
htmlhelp_basename = "musicbrainzngsdoc"
198197

199198

200199
# -- Options for LaTeX output --------------------------------------------------
201200

202201
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': '',
211208
}
212209

213210
# Grouping the document tree into LaTeX files. List of tuples
214211
# (source start file, target name, title, author, documentclass [howto/manual]).
215212
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"),
218214
]
219215

220216
# The name of an image file (relative to this directory) to place at the top of
221217
# the title page.
222-
#latex_logo = None
218+
# latex_logo = None
223219

224220
# For "manual" documents, if this is true, then toplevel headings are parts,
225221
# not chapters.
226-
#latex_use_parts = False
222+
# latex_use_parts = False
227223

228224
# If true, show page references after internal links.
229-
#latex_show_pagerefs = False
225+
# latex_show_pagerefs = False
230226

231227
# If true, show URL addresses after external links.
232-
#latex_show_urls = False
228+
# latex_show_urls = False
233229

234230
# Documents to append as an appendix to all manuals.
235-
#latex_appendices = []
231+
# latex_appendices = []
236232

237233
# If false, no module index is generated.
238-
#latex_domain_indices = True
234+
# latex_domain_indices = True
239235

240236

241237
# -- Options for manual page output --------------------------------------------
242238

243239
# One entry per manual page. List of tuples
244240
# (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)]
249242

250243
# If true, show URL addresses after external links.
251-
#man_show_urls = False
244+
# man_show_urls = False
252245

253246

254247
# -- Options for Texinfo output ------------------------------------------------
@@ -257,16 +250,22 @@
257250
# (source start file, target name, title, author,
258251
# dir menu entry, description, category)
259252
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+
),
263262
]
264263

265264
# Documents to append as an appendix to all manuals.
266-
#texinfo_appendices = []
265+
# texinfo_appendices = []
267266

268267
# If false, no module index is generated.
269-
#texinfo_domain_indices = True
268+
# texinfo_domain_indices = True
270269

271270
# How to display URL addresses: 'footnote', 'no', or 'inline'.
272-
#texinfo_show_urls = 'footnote'
271+
# texinfo_show_urls = 'footnote'

0 commit comments

Comments
 (0)