Skip to content

Commit 7f2fd19

Browse files
committed
Fixes pep8 errors in the sphinx config
1 parent 716e522 commit 7f2fd19

1 file changed

Lines changed: 41 additions & 41 deletions

File tree

docs/conf.py

Lines changed: 41 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
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.
@@ -35,7 +35,7 @@
3535
source_suffix = '.rst'
3636

3737
# The encoding of source files.
38-
#source_encoding = 'utf-8-sig'
38+
# source_encoding = 'utf-8-sig'
3939

4040
# The master toctree document.
4141
master_doc = 'index'
@@ -57,37 +57,37 @@
5757

5858
# The language for content autogenerated by Sphinx. Refer to documentation
5959
# for a list of supported languages.
60-
#language = None
60+
# language = None
6161

6262
# There are two options for replacing |today|: either, you set today to some
6363
# non-false value, then it is used:
64-
#today = ''
64+
# today = ''
6565
# Else, today_fmt is used as the format for a strftime call.
66-
#today_fmt = '%B %d, %Y'
66+
# today_fmt = '%B %d, %Y'
6767

6868
# List of patterns, relative to source directory, that match files and
6969
# directories to ignore when looking for source files.
7070
exclude_patterns = ['_build']
7171

7272
# The reST default role (used for this markup: `text`) to use for all documents.
73-
#default_role = None
73+
# default_role = None
7474

7575
# If true, '()' will be appended to :func: etc. cross-reference text.
76-
#add_function_parentheses = True
76+
# add_function_parentheses = True
7777

7878
# If true, the current module name will be prepended to all description
7979
# unit titles (such as .. function::).
80-
#add_module_names = True
80+
# add_module_names = True
8181

8282
# If true, sectionauthor and moduleauthor directives will be shown in the
8383
# output. They are ignored by default.
84-
#show_authors = False
84+
# show_authors = False
8585

8686
# The name of the Pygments (syntax highlighting) style to use.
8787
pygments_style = 'friendly'
8888

8989
# A list of ignored prefixes for module index sorting.
90-
#modindex_common_prefix = []
90+
# modindex_common_prefix = []
9191

9292

9393
# -- Options for HTML output ---------------------------------------------------
@@ -104,26 +104,26 @@
104104
# Theme options are theme-specific and customize the look and feel of a theme
105105
# further. For a list of options available for each theme, see the
106106
# documentation.
107-
#html_theme_options = {}
107+
# html_theme_options = {}
108108

109109
# Add any paths that contain custom themes here, relative to this directory.
110-
#html_theme_path = []
110+
# html_theme_path = []
111111

112112
# The name for this set of Sphinx documents. If None, it defaults to
113113
# "<project> v<release> documentation".
114-
#html_title = None
114+
# html_title = None
115115

116116
# A shorter title for the navigation bar. Default is the same as html_title.
117-
#html_short_title = None
117+
# html_short_title = None
118118

119119
# The name of an image file (relative to this directory) to place at the top
120120
# of the sidebar.
121-
#html_logo = None
121+
# html_logo = None
122122

123123
# The name of an image file (within the static path) to use as favicon of the
124124
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
125125
# pixels large.
126-
#html_favicon = None
126+
# html_favicon = None
127127

128128
# Add any paths that contain custom static files (such as style sheets) here,
129129
# relative to this directory. They are copied after the builtin static files,
@@ -132,44 +132,44 @@
132132

133133
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
134134
# using the given strftime format.
135-
#html_last_updated_fmt = '%b %d, %Y'
135+
# html_last_updated_fmt = '%b %d, %Y'
136136

137137
# If true, SmartyPants will be used to convert quotes and dashes to
138138
# typographically correct entities.
139-
#html_use_smartypants = True
139+
# html_use_smartypants = True
140140

141141
# Custom sidebar templates, maps document names to template names.
142-
#html_sidebars = {}
142+
# html_sidebars = {}
143143

144144
# Additional templates that should be rendered to pages, maps page names to
145145
# template names.
146-
#html_additional_pages = {}
146+
# html_additional_pages = {}
147147

148148
# If false, no module index is generated.
149-
#html_domain_indices = True
149+
# html_domain_indices = True
150150

151151
# If false, no index is generated.
152-
#html_use_index = True
152+
# html_use_index = True
153153

154154
# If true, the index is split into individual pages for each letter.
155-
#html_split_index = False
155+
# html_split_index = False
156156

157157
# If true, links to the reST sources are added to the pages.
158-
#html_show_sourcelink = True
158+
# html_show_sourcelink = True
159159

160160
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
161-
#html_show_sphinx = True
161+
# html_show_sphinx = True
162162

163163
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
164-
#html_show_copyright = True
164+
# html_show_copyright = True
165165

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

171171
# This is the file name suffix for HTML files (e.g. ".xhtml").
172-
#html_file_suffix = None
172+
# html_file_suffix = None
173173

174174
# Output file base name for HTML help builder.
175175
htmlhelp_basename = 'SoftLayerAPIPythonClientdoc'
@@ -179,13 +179,13 @@
179179

180180
latex_elements = {
181181
# The paper size ('letterpaper' or 'a4paper').
182-
#'papersize': 'letterpaper',
182+
# 'papersize': 'letterpaper',
183183

184184
# The font size ('10pt', '11pt' or '12pt').
185-
#'pointsize': '10pt',
185+
# 'pointsize': '10pt',
186186

187187
# Additional stuff for the LaTeX preamble.
188-
#'preamble': '',
188+
# 'preamble': '',
189189
}
190190

191191
# Grouping the document tree into LaTeX files. List of tuples
@@ -197,23 +197,23 @@
197197

198198
# The name of an image file (relative to this directory) to place at the top of
199199
# the title page.
200-
#latex_logo = None
200+
# latex_logo = None
201201

202202
# For "manual" documents, if this is true, then toplevel headings are parts,
203203
# not chapters.
204-
#latex_use_parts = False
204+
# latex_use_parts = False
205205

206206
# If true, show page references after internal links.
207-
#latex_show_pagerefs = False
207+
# latex_show_pagerefs = False
208208

209209
# If true, show URL addresses after external links.
210-
#latex_show_urls = False
210+
# latex_show_urls = False
211211

212212
# Documents to append as an appendix to all manuals.
213-
#latex_appendices = []
213+
# latex_appendices = []
214214

215215
# If false, no module index is generated.
216-
#latex_domain_indices = True
216+
# latex_domain_indices = True
217217

218218

219219
# -- Options for manual page output --------------------------------------------
@@ -226,7 +226,7 @@
226226
]
227227

228228
# If true, show URL addresses after external links.
229-
#man_show_urls = False
229+
# man_show_urls = False
230230

231231

232232
# -- Options for Texinfo output ------------------------------------------------
@@ -241,10 +241,10 @@
241241
]
242242

243243
# Documents to append as an appendix to all manuals.
244-
#texinfo_appendices = []
244+
# texinfo_appendices = []
245245

246246
# If false, no module index is generated.
247-
#texinfo_domain_indices = True
247+
# texinfo_domain_indices = True
248248

249249
# How to display URL addresses: 'footnote', 'no', or 'inline'.
250-
#texinfo_show_urls = 'footnote'
250+
# texinfo_show_urls = 'footnote'

0 commit comments

Comments
 (0)