Skip to content

Commit 5d23f14

Browse files
authored
fix linter issues in conf.py (#2214)
1 parent 136cf47 commit 5d23f14

File tree

1 file changed

+34
-33
lines changed

1 file changed

+34
-33
lines changed

docs/sphinx/source/conf.py

+34-33
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
# use napoleon in lieu of numpydoc 2019-04-23
3939

4040
# If your documentation needs a minimal Sphinx version, state it here.
41-
#needs_sphinx = '1.0'
41+
# needs_sphinx = '1.0'
4242

4343
# Add any Sphinx extension module names here, as strings. They can be
4444
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
@@ -70,7 +70,7 @@
7070
source_suffix = '.rst'
7171

7272
# The encoding of source files.
73-
#source_encoding = 'utf-8-sig'
73+
# source_encoding = 'utf-8-sig'
7474

7575
# The master toctree document.
7676
master_doc = 'index'
@@ -94,41 +94,41 @@
9494

9595
# The language for content autogenerated by Sphinx. Refer to documentation
9696
# for a list of supported languages.
97-
#language = None
97+
# language = None
9898

9999
# There are two options for replacing |today|: either, you set today to some
100100
# non-false value, then it is used:
101-
#today = ''
101+
# today = ''
102102
# Else, today_fmt is used as the format for a strftime call.
103-
#today_fmt = '%B %d, %Y'
103+
# today_fmt = '%B %d, %Y'
104104

105105
# List of patterns, relative to source directory, that match files and
106106
# directories to ignore when looking for source files.
107107
exclude_patterns = ['whatsnew/*', '**.ipynb_checkpoints']
108108

109109
# The reST default role (used for this markup: `text`) to use for all
110110
# documents.
111-
#default_role = None
111+
# default_role = None
112112

113113
# If true, '()' will be appended to :func: etc. cross-reference text.
114-
#add_function_parentheses = True
114+
# add_function_parentheses = True
115115

116116
# If true, the current module name will be prepended to all description
117117
# unit titles (such as .. function::).
118-
#add_module_names = True
118+
# add_module_names = True
119119

120120
# If true, sectionauthor and moduleauthor directives will be shown in the
121121
# output. They are ignored by default.
122-
#show_authors = False
122+
# show_authors = False
123123

124124
# The name of the Pygments (syntax highlighting) style to use.
125125
pygments_style = 'sphinx'
126126

127127
# A list of ignored prefixes for module index sorting.
128-
#modindex_common_prefix = []
128+
# modindex_common_prefix = []
129129

130130
# If true, keep warnings as "system message" paragraphs in the built documents.
131-
#keep_warnings = False
131+
# keep_warnings = False
132132

133133
autosummary_generate = True
134134

@@ -183,10 +183,10 @@
183183

184184
# The name for this set of Sphinx documents. If None, it defaults to
185185
# "<project> v<release> documentation".
186-
#html_title = None
186+
# html_title = None
187187

188188
# A shorter title for the navigation bar. Default is the same as html_title.
189-
#html_short_title = None
189+
# html_short_title = None
190190

191191
# The name of an image file (relative to this directory) to place at the top
192192
# of the sidebar.
@@ -195,7 +195,7 @@
195195
# The name of an image file (within the static path) to use as favicon of the
196196
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
197197
# pixels large.
198-
#html_favicon = None
198+
# html_favicon = None
199199

200200
# Add any paths that contain custom static files (such as style sheets) here,
201201
# relative to this directory. They are copied after the builtin static files,
@@ -245,10 +245,10 @@
245245
# If true, an OpenSearch description file will be output, and all pages will
246246
# contain a <link> tag referring to it. The value of this option must be the
247247
# base URL from which the finished HTML is served.
248-
#html_use_opensearch = ''
248+
# html_use_opensearch = ''
249249

250250
# This is the file name suffix for HTML files (e.g. ".xhtml").
251-
#html_file_suffix = None
251+
# html_file_suffix = None
252252

253253
# Output file base name for HTML help builder.
254254
htmlhelp_basename = 'pvlib_pythondoc'
@@ -266,15 +266,16 @@ def setup(app):
266266

267267
# -- Options for LaTeX output ---------------------------------------------
268268

269+
269270
latex_elements = {
270-
# The paper size ('letterpaper' or 'a4paper').
271-
#'papersize': 'letterpaper',
271+
# The paper size ('letterpaper' or 'a4paper').
272+
# 'papersize': 'letterpaper',
272273

273-
# The font size ('10pt', '11pt' or '12pt').
274-
#'pointsize': '10pt',
274+
# The font size ('10pt', '11pt' or '12pt').
275+
# 'pointsize': '10pt',
275276

276-
# Additional stuff for the LaTeX preamble.
277-
#'preamble': '',
277+
# Additional stuff for the LaTeX preamble.
278+
# 'preamble': '',
278279
}
279280

280281
# Grouping the document tree into LaTeX files. List of tuples
@@ -288,23 +289,23 @@ def setup(app):
288289

289290
# The name of an image file (relative to this directory) to place at the top of
290291
# the title page.
291-
#latex_logo = None
292+
# latex_logo = None
292293

293294
# For "manual" documents, if this is true, then toplevel headings are parts,
294295
# not chapters.
295-
#latex_use_parts = False
296+
# latex_use_parts = False
296297

297298
# If true, show page references after internal links.
298-
#latex_show_pagerefs = False
299+
# latex_show_pagerefs = False
299300

300301
# If true, show URL addresses after external links.
301-
#latex_show_urls = False
302+
# latex_show_urls = False
302303

303304
# Documents to append as an appendix to all manuals.
304-
#latex_appendices = []
305+
# latex_appendices = []
305306

306307
# If false, no module index is generated.
307-
#latex_domain_indices = True
308+
# latex_domain_indices = True
308309

309310
# extlinks alias
310311
extlinks = {
@@ -329,7 +330,7 @@ def setup(app):
329330
]
330331

331332
# If true, show URL addresses after external links.
332-
#man_show_urls = False
333+
# man_show_urls = False
333334

334335

335336
# -- Options for Texinfo output -------------------------------------------
@@ -345,16 +346,16 @@ def setup(app):
345346
]
346347

347348
# Documents to append as an appendix to all manuals.
348-
#texinfo_appendices = []
349+
# texinfo_appendices = []
349350

350351
# If false, no module index is generated.
351-
#texinfo_domain_indices = True
352+
# texinfo_domain_indices = True
352353

353354
# How to display URL addresses: 'footnote', 'no', or 'inline'.
354-
#texinfo_show_urls = 'footnote'
355+
# texinfo_show_urls = 'footnote'
355356

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

359360
# Example configuration for intersphinx: refer to the Python standard library.
360361
intersphinx_mapping = {

0 commit comments

Comments
 (0)