Skip to content

Commit 471ffa3

Browse files
committed
Fix pep8 warnings in ./docs/conf.py
1 parent 1a08e5c commit 471ffa3

File tree

1 file changed

+50
-50
lines changed

1 file changed

+50
-50
lines changed

docs/conf.py

Lines changed: 50 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
# -- General configuration ------------------------------------------------
4242

4343
# If your documentation needs a minimal Sphinx version, state it here.
44-
#needs_sphinx = '1.0'
44+
# needs_sphinx = '1.0'
4545

4646
# Add any Sphinx extension module names here, as strings. They can be
4747
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
@@ -61,7 +61,7 @@
6161
source_suffix = '.rst'
6262

6363
# The encoding of source files.
64-
#source_encoding = 'utf-8-sig'
64+
# source_encoding = 'utf-8-sig'
6565

6666
# The master toctree document.
6767
master_doc = 'index'
@@ -81,41 +81,41 @@
8181

8282
# The language for content autogenerated by Sphinx. Refer to documentation
8383
# for a list of supported languages.
84-
#language = None
84+
# language = None
8585

8686
# There are two options for replacing |today|: either, you set today to some
8787
# non-false value, then it is used:
88-
#today = ''
88+
# today = ''
8989
# Else, today_fmt is used as the format for a strftime call.
90-
#today_fmt = '%B %d, %Y'
90+
# today_fmt = '%B %d, %Y'
9191

9292
# List of patterns, relative to source directory, that match files and
9393
# directories to ignore when looking for source files.
9494
exclude_patterns = ['_build']
9595

9696
# The reST default role (used for this markup: `text`) to use for all
9797
# documents.
98-
#default_role = None
98+
# default_role = None
9999

100100
# If true, '()' will be appended to :func: etc. cross-reference text.
101-
#add_function_parentheses = True
101+
# add_function_parentheses = True
102102

103103
# If true, the current module name will be prepended to all description
104104
# unit titles (such as .. function::).
105-
#add_module_names = True
105+
# add_module_names = True
106106

107107
# If true, sectionauthor and moduleauthor directives will be shown in the
108108
# output. They are ignored by default.
109-
#show_authors = False
109+
# show_authors = False
110110

111111
# The name of the Pygments (syntax highlighting) style to use.
112112
pygments_style = 'sphinx'
113113

114114
# A list of ignored prefixes for module index sorting.
115-
#modindex_common_prefix = []
115+
# modindex_common_prefix = []
116116

117117
# If true, keep warnings as "system message" paragraphs in the built documents.
118-
#keep_warnings = False
118+
# keep_warnings = False
119119

120120

121121
# -- Options for HTML output ----------------------------------------------
@@ -127,17 +127,17 @@
127127
# Theme options are theme-specific and customize the look and feel of a theme
128128
# further. For a list of options available for each theme, see the
129129
# documentation.
130-
#html_theme_options = {}
130+
# html_theme_options = {}
131131

132132
# Add any paths that contain custom themes here, relative to this directory.
133-
#html_theme_path = []
133+
# html_theme_path = []
134134

135135
# The name for this set of Sphinx documents. If None, it defaults to
136136
# "<project> v<release> documentation".
137-
#html_title = None
137+
# html_title = None
138138

139139
# A shorter title for the navigation bar. Default is the same as html_title.
140-
#html_short_title = None
140+
# html_short_title = None
141141

142142
# The name of an image file (relative to this directory) to place at the top
143143
# of the sidebar.
@@ -156,48 +156,48 @@
156156
# Add any extra paths that contain custom files (such as robots.txt or
157157
# .htaccess) here, relative to this directory. These files are copied
158158
# directly to the root of the documentation.
159-
#html_extra_path = []
159+
# html_extra_path = []
160160

161161
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
162162
# using the given strftime format.
163-
#html_last_updated_fmt = '%b %d, %Y'
163+
# html_last_updated_fmt = '%b %d, %Y'
164164

165165
# If true, SmartyPants will be used to convert quotes and dashes to
166166
# typographically correct entities.
167-
#html_use_smartypants = True
167+
# html_use_smartypants = True
168168

169169
# Custom sidebar templates, maps document names to template names.
170-
#html_sidebars = {}
170+
# html_sidebars = {}
171171

172172
# Additional templates that should be rendered to pages, maps page names to
173173
# template names.
174-
#html_additional_pages = {}
174+
# html_additional_pages = {}
175175

176176
# If false, no module index is generated.
177-
#html_domain_indices = True
177+
# html_domain_indices = True
178178

179179
# If false, no index is generated.
180-
#html_use_index = True
180+
# html_use_index = True
181181

182182
# If true, the index is split into individual pages for each letter.
183-
#html_split_index = False
183+
# html_split_index = False
184184

185185
# If true, links to the reST sources are added to the pages.
186-
#html_show_sourcelink = True
186+
# html_show_sourcelink = True
187187

188188
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
189-
#html_show_sphinx = True
189+
# html_show_sphinx = True
190190

191191
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
192-
#html_show_copyright = True
192+
# html_show_copyright = True
193193

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

199199
# This is the file name suffix for HTML files (e.g. ".xhtml").
200-
#html_file_suffix = None
200+
# html_file_suffix = None
201201

202202
# Output file base name for HTML help builder.
203203
htmlhelp_basename = 'aiohttpdoc'
@@ -206,43 +206,43 @@
206206
# -- Options for LaTeX output ---------------------------------------------
207207

208208
latex_elements = {
209-
# The paper size ('letterpaper' or 'a4paper').
210-
#'papersize': 'letterpaper',
209+
# The paper size ('letterpaper' or 'a4paper').
210+
# 'papersize': 'letterpaper',
211211

212-
# The font size ('10pt', '11pt' or '12pt').
213-
#'pointsize': '10pt',
212+
# The font size ('10pt', '11pt' or '12pt').
213+
# 'pointsize': '10pt',
214214

215-
# Additional stuff for the LaTeX preamble.
216-
#'preamble': '',
215+
# Additional stuff for the LaTeX preamble.
216+
# 'preamble': '',
217217
}
218218

219219
# Grouping the document tree into LaTeX files. List of tuples
220220
# (source start file, target name, title,
221221
# author, documentclass [howto, manual, or own class]).
222222
latex_documents = [
223-
('index', 'aiohttp.tex', 'aiohttp Documentation',
224-
'KeepSafe', 'manual'),
223+
('index', 'aiohttp.tex', 'aiohttp Documentation',
224+
'KeepSafe', 'manual'),
225225
]
226226

227227
# The name of an image file (relative to this directory) to place at the top of
228228
# the title page.
229-
#latex_logo = None
229+
# latex_logo = None
230230

231231
# For "manual" documents, if this is true, then toplevel headings are parts,
232232
# not chapters.
233-
#latex_use_parts = False
233+
# latex_use_parts = False
234234

235235
# If true, show page references after internal links.
236-
#latex_show_pagerefs = False
236+
# latex_show_pagerefs = False
237237

238238
# If true, show URL addresses after external links.
239-
#latex_show_urls = False
239+
# latex_show_urls = False
240240

241241
# Documents to append as an appendix to all manuals.
242-
#latex_appendices = []
242+
# latex_appendices = []
243243

244244
# If false, no module index is generated.
245-
#latex_domain_indices = True
245+
# latex_domain_indices = True
246246

247247

248248
# -- Options for manual page output ---------------------------------------
@@ -255,7 +255,7 @@
255255
]
256256

257257
# If true, show URL addresses after external links.
258-
#man_show_urls = False
258+
# man_show_urls = False
259259

260260

261261
# -- Options for Texinfo output -------------------------------------------
@@ -264,19 +264,19 @@
264264
# (source start file, target name, title, author,
265265
# dir menu entry, description, category)
266266
texinfo_documents = [
267-
('index', 'aiohttp', 'aiohttp Documentation',
268-
'KeepSafe', 'aiohttp', 'One line description of project.',
269-
'Miscellaneous'),
267+
('index', 'aiohttp', 'aiohttp Documentation',
268+
'KeepSafe', 'aiohttp', 'One line description of project.',
269+
'Miscellaneous'),
270270
]
271271

272272
# Documents to append as an appendix to all manuals.
273-
#texinfo_appendices = []
273+
# texinfo_appendices = []
274274

275275
# If false, no module index is generated.
276-
#texinfo_domain_indices = True
276+
# texinfo_domain_indices = True
277277

278278
# How to display URL addresses: 'footnote', 'no', or 'inline'.
279-
#texinfo_show_urls = 'footnote'
279+
# texinfo_show_urls = 'footnote'
280280

281281
# If true, do not generate a @detailmenu in the "Top" node's menu.
282-
#texinfo_no_detailmenu = False
282+
# texinfo_no_detailmenu = False

0 commit comments

Comments
 (0)