Skip to content

Commit 6867176

Browse files
committed
style: reformat all code with black
1 parent 951f744 commit 6867176

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+1976
-1408
lines changed

docs/conf.py

Lines changed: 72 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -21,119 +21,121 @@ def __init__(self, *args):
2121
def __getattr__(self, name):
2222
return Mock
2323

24-
MOCK_MODULES = ['zookeeper']
24+
25+
MOCK_MODULES = ["zookeeper"]
2526
for mod_name in MOCK_MODULES:
2627
sys.modules[mod_name] = Mock()
2728

2829
# If extensions (or modules to document with autodoc) are in another directory,
2930
# add these directories to sys.path here. If the directory is relative to the
3031
# documentation root, use os.path.abspath to make it absolute, like shown here.
31-
sys.path.insert(0, os.path.abspath('..'))
32+
sys.path.insert(0, os.path.abspath(".."))
3233

3334
# -- General configuration -----------------------------------------------------
3435

3536
# If your documentation needs a minimal Sphinx version, state it here.
36-
#needs_sphinx = '1.0'
37+
# needs_sphinx = '1.0'
3738

3839
# Add any Sphinx extension module names here, as strings. They can be extensions
3940
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
4041
extensions = [
41-
'sphinx.ext.autodoc',
42-
'sphinx.ext.doctest',
43-
'sphinx.ext.viewcode',
42+
"sphinx.ext.autodoc",
43+
"sphinx.ext.doctest",
44+
"sphinx.ext.viewcode",
4445
]
4546

4647
# Add any paths that contain templates here, relative to this directory.
47-
templates_path = ['_templates']
48+
templates_path = ["_templates"]
4849

4950
# The suffix of source filenames.
50-
source_suffix = '.rst'
51+
source_suffix = ".rst"
5152

5253
# The encoding of source files.
53-
#source_encoding = 'utf-8-sig'
54+
# source_encoding = 'utf-8-sig'
5455

5556
# The master toctree document.
56-
master_doc = 'index'
57+
master_doc = "index"
5758

5859
# General information about the project.
59-
project = u'kazoo'
60-
copyright = u'2011-2014, Kazoo team'
60+
project = "kazoo"
61+
copyright = "2011-2014, Kazoo team"
6162

6263
# The version info for the project you're documenting, acts as replacement for
6364
# |version| and |release|, also used in various other places throughout the
6465
# built documents.
6566
#
6667
# The full version, including alpha/beta/rc tags.
6768
from kazoo import version
69+
6870
release = version.__version__
6971

7072
# The short X.Y version.
71-
version = '.'.join(release.split('.')[:-1])
73+
version = ".".join(release.split(".")[:-1])
7274

7375
# The language for content autogenerated by Sphinx. Refer to documentation
7476
# for a list of supported languages.
75-
#language = None
77+
# language = None
7678

7779
# There are two options for replacing |today|: either, you set today to some
7880
# non-false value, then it is used:
79-
#today = ''
81+
# today = ''
8082
# Else, today_fmt is used as the format for a strftime call.
81-
#today_fmt = '%B %d, %Y'
83+
# today_fmt = '%B %d, %Y'
8284

8385
# List of patterns, relative to source directory, that match files and
8486
# directories to ignore when looking for source files.
85-
exclude_patterns = ['_build']
87+
exclude_patterns = ["_build"]
8688

8789
# The reST default role (used for this markup: `text`) to use for all documents.
88-
#default_role = None
90+
# default_role = None
8991

9092
# If true, '()' will be appended to :func: etc. cross-reference text.
91-
#add_function_parentheses = True
93+
# add_function_parentheses = True
9294

9395
# If true, the current module name will be prepended to all description
9496
# unit titles (such as .. function::).
95-
#add_module_names = True
97+
# add_module_names = True
9698

9799
# If true, sectionauthor and moduleauthor directives will be shown in the
98100
# output. They are ignored by default.
99-
#show_authors = False
101+
# show_authors = False
100102

101103
# The name of the Pygments (syntax highlighting) style to use.
102-
pygments_style = 'sphinx'
104+
pygments_style = "sphinx"
103105

104106
# A list of ignored prefixes for module index sorting.
105-
#modindex_common_prefix = []
107+
# modindex_common_prefix = []
106108

107109

108110
# -- Options for HTML output ---------------------------------------------------
109111

110112
# The theme to use for HTML and HTML Help pages. See the documentation for
111113
# a list of builtin themes.
112-
html_theme = 'default'
114+
html_theme = "default"
113115

114116
# Theme options are theme-specific and customize the look and feel of a theme
115117
# further. For a list of options available for each theme, see the
116118
# documentation.
117-
#html_theme_options = {}
119+
# html_theme_options = {}
118120

119121
# Add any paths that contain custom themes here, relative to this directory.
120-
#html_theme_path = []
122+
# html_theme_path = []
121123

122124
# The name for this set of Sphinx documents. If None, it defaults to
123125
# "<project> v<release> documentation".
124-
#html_title = None
126+
# html_title = None
125127

126128
# A shorter title for the navigation bar. Default is the same as html_title.
127-
#html_short_title = None
129+
# html_short_title = None
128130

129131
# The name of an image file (relative to this directory) to place at the top
130132
# of the sidebar.
131-
#html_logo = None
133+
# html_logo = None
132134

133135
# The name of an image file (within the static path) to use as favicon of the
134136
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
135137
# pixels large.
136-
#html_favicon = None
138+
# html_favicon = None
137139

138140
# Add any paths that contain custom static files (such as style sheets) here,
139141
# relative to this directory. They are copied after the builtin static files,
@@ -142,101 +144,95 @@ def __getattr__(self, name):
142144

143145
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
144146
# using the given strftime format.
145-
#html_last_updated_fmt = '%b %d, %Y'
147+
# html_last_updated_fmt = '%b %d, %Y'
146148

147149
# If true, SmartyPants will be used to convert quotes and dashes to
148150
# typographically correct entities.
149-
#html_use_smartypants = True
151+
# html_use_smartypants = True
150152

151153
# Custom sidebar templates, maps document names to template names.
152-
#html_sidebars = {}
154+
# html_sidebars = {}
153155

154156
# Additional templates that should be rendered to pages, maps page names to
155157
# template names.
156-
#html_additional_pages = {}
158+
# html_additional_pages = {}
157159

158160
# If false, no module index is generated.
159-
#html_domain_indices = True
161+
# html_domain_indices = True
160162

161163
# If false, no index is generated.
162-
#html_use_index = True
164+
# html_use_index = True
163165

164166
# If true, the index is split into individual pages for each letter.
165-
#html_split_index = False
167+
# html_split_index = False
166168

167169
# If true, links to the reST sources are added to the pages.
168-
#html_show_sourcelink = True
170+
# html_show_sourcelink = True
169171

170172
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
171-
#html_show_sphinx = True
173+
# html_show_sphinx = True
172174

173175
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
174-
#html_show_copyright = True
176+
# html_show_copyright = True
175177

176178
# If true, an OpenSearch description file will be output, and all pages will
177179
# contain a <link> tag referring to it. The value of this option must be the
178180
# base URL from which the finished HTML is served.
179-
#html_use_opensearch = ''
181+
# html_use_opensearch = ''
180182

181183
# This is the file name suffix for HTML files (e.g. ".xhtml").
182-
#html_file_suffix = None
184+
# html_file_suffix = None
183185

184186
# Output file base name for HTML help builder.
185-
htmlhelp_basename = 'kazoodoc'
187+
htmlhelp_basename = "kazoodoc"
186188

187189

188190
# -- Options for LaTeX output --------------------------------------------------
189191

190192
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': '',
193+
# The paper size ('letterpaper' or 'a4paper').
194+
#'papersize': 'letterpaper',
195+
# The font size ('10pt', '11pt' or '12pt').
196+
#'pointsize': '10pt',
197+
# Additional stuff for the LaTeX preamble.
198+
#'preamble': '',
199199
}
200200

201201
# Grouping the document tree into LaTeX files. List of tuples
202202
# (source start file, target name, title, author, documentclass [howto/manual]).
203203
latex_documents = [
204-
('index', 'kazoo.tex', u'kazoo Documentation',
205-
u'Various Authors', 'manual'),
204+
("index", "kazoo.tex", "kazoo Documentation", "Various Authors", "manual"),
206205
]
207206

208207
# The name of an image file (relative to this directory) to place at the top of
209208
# the title page.
210-
#latex_logo = None
209+
# latex_logo = None
211210

212211
# For "manual" documents, if this is true, then toplevel headings are parts,
213212
# not chapters.
214-
#latex_use_parts = False
213+
# latex_use_parts = False
215214

216215
# If true, show page references after internal links.
217-
#latex_show_pagerefs = False
216+
# latex_show_pagerefs = False
218217

219218
# If true, show URL addresses after external links.
220-
#latex_show_urls = False
219+
# latex_show_urls = False
221220

222221
# Documents to append as an appendix to all manuals.
223-
#latex_appendices = []
222+
# latex_appendices = []
224223

225224
# If false, no module index is generated.
226-
#latex_domain_indices = True
225+
# latex_domain_indices = True
227226

228227

229228
# -- Options for manual page output --------------------------------------------
230229

231230
# One entry per manual page. List of tuples
232231
# (source start file, name, description, authors, manual section).
233-
man_pages = [
234-
('index', 'kazoo', u'kazoo Documentation',
235-
[u'Various Authors'], 1)
236-
]
232+
man_pages = [("index", "kazoo", "kazoo Documentation", ["Various Authors"], 1)]
237233

238234
# If true, show URL addresses after external links.
239-
#man_show_urls = False
235+
# man_show_urls = False
240236

241237

242238
# -- Options for Texinfo output ------------------------------------------------
@@ -245,15 +241,22 @@ def __getattr__(self, name):
245241
# (source start file, target name, title, author,
246242
# dir menu entry, description, category)
247243
texinfo_documents = [
248-
('index', 'kazoo', u'kazoo Documentation', u'Various Authors',
249-
'kazoo', 'One line description of project.', 'Miscellaneous'),
244+
(
245+
"index",
246+
"kazoo",
247+
"kazoo Documentation",
248+
"Various Authors",
249+
"kazoo",
250+
"One line description of project.",
251+
"Miscellaneous",
252+
),
250253
]
251254

252255
# Documents to append as an appendix to all manuals.
253-
#texinfo_appendices = []
256+
# texinfo_appendices = []
254257

255258
# If false, no module index is generated.
256-
#texinfo_domain_indices = True
259+
# texinfo_domain_indices = True
257260

258261
# How to display URL addresses: 'footnote', 'no', or 'inline'.
259-
#texinfo_show_urls = 'footnote'
262+
# texinfo_show_urls = 'footnote'

0 commit comments

Comments
 (0)