38
38
# use napoleon in lieu of numpydoc 2019-04-23
39
39
40
40
# If your documentation needs a minimal Sphinx version, state it here.
41
- #needs_sphinx = '1.0'
41
+ # needs_sphinx = '1.0'
42
42
43
43
# Add any Sphinx extension module names here, as strings. They can be
44
44
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
70
70
source_suffix = '.rst'
71
71
72
72
# The encoding of source files.
73
- #source_encoding = 'utf-8-sig'
73
+ # source_encoding = 'utf-8-sig'
74
74
75
75
# The master toctree document.
76
76
master_doc = 'index'
94
94
95
95
# The language for content autogenerated by Sphinx. Refer to documentation
96
96
# for a list of supported languages.
97
- #language = None
97
+ # language = None
98
98
99
99
# There are two options for replacing |today|: either, you set today to some
100
100
# non-false value, then it is used:
101
- #today = ''
101
+ # today = ''
102
102
# Else, today_fmt is used as the format for a strftime call.
103
- #today_fmt = '%B %d, %Y'
103
+ # today_fmt = '%B %d, %Y'
104
104
105
105
# List of patterns, relative to source directory, that match files and
106
106
# directories to ignore when looking for source files.
107
107
exclude_patterns = ['whatsnew/*' , '**.ipynb_checkpoints' ]
108
108
109
109
# The reST default role (used for this markup: `text`) to use for all
110
110
# documents.
111
- #default_role = None
111
+ # default_role = None
112
112
113
113
# If true, '()' will be appended to :func: etc. cross-reference text.
114
- #add_function_parentheses = True
114
+ # add_function_parentheses = True
115
115
116
116
# If true, the current module name will be prepended to all description
117
117
# unit titles (such as .. function::).
118
- #add_module_names = True
118
+ # add_module_names = True
119
119
120
120
# If true, sectionauthor and moduleauthor directives will be shown in the
121
121
# output. They are ignored by default.
122
- #show_authors = False
122
+ # show_authors = False
123
123
124
124
# The name of the Pygments (syntax highlighting) style to use.
125
125
pygments_style = 'sphinx'
126
126
127
127
# A list of ignored prefixes for module index sorting.
128
- #modindex_common_prefix = []
128
+ # modindex_common_prefix = []
129
129
130
130
# If true, keep warnings as "system message" paragraphs in the built documents.
131
- #keep_warnings = False
131
+ # keep_warnings = False
132
132
133
133
autosummary_generate = True
134
134
183
183
184
184
# The name for this set of Sphinx documents. If None, it defaults to
185
185
# "<project> v<release> documentation".
186
- #html_title = None
186
+ # html_title = None
187
187
188
188
# A shorter title for the navigation bar. Default is the same as html_title.
189
- #html_short_title = None
189
+ # html_short_title = None
190
190
191
191
# The name of an image file (relative to this directory) to place at the top
192
192
# of the sidebar.
195
195
# The name of an image file (within the static path) to use as favicon of the
196
196
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
197
197
# pixels large.
198
- #html_favicon = None
198
+ # html_favicon = None
199
199
200
200
# Add any paths that contain custom static files (such as style sheets) here,
201
201
# relative to this directory. They are copied after the builtin static files,
245
245
# If true, an OpenSearch description file will be output, and all pages will
246
246
# contain a <link> tag referring to it. The value of this option must be the
247
247
# base URL from which the finished HTML is served.
248
- #html_use_opensearch = ''
248
+ # html_use_opensearch = ''
249
249
250
250
# This is the file name suffix for HTML files (e.g. ".xhtml").
251
- #html_file_suffix = None
251
+ # html_file_suffix = None
252
252
253
253
# Output file base name for HTML help builder.
254
254
htmlhelp_basename = 'pvlib_pythondoc'
@@ -266,15 +266,16 @@ def setup(app):
266
266
267
267
# -- Options for LaTeX output ---------------------------------------------
268
268
269
+
269
270
latex_elements = {
270
- # The paper size ('letterpaper' or 'a4paper').
271
- # 'papersize': 'letterpaper',
271
+ # The paper size ('letterpaper' or 'a4paper').
272
+ # 'papersize': 'letterpaper',
272
273
273
- # The font size ('10pt', '11pt' or '12pt').
274
- # 'pointsize': '10pt',
274
+ # The font size ('10pt', '11pt' or '12pt').
275
+ # 'pointsize': '10pt',
275
276
276
- # Additional stuff for the LaTeX preamble.
277
- # 'preamble': '',
277
+ # Additional stuff for the LaTeX preamble.
278
+ # 'preamble': '',
278
279
}
279
280
280
281
# Grouping the document tree into LaTeX files. List of tuples
@@ -288,23 +289,23 @@ def setup(app):
288
289
289
290
# The name of an image file (relative to this directory) to place at the top of
290
291
# the title page.
291
- #latex_logo = None
292
+ # latex_logo = None
292
293
293
294
# For "manual" documents, if this is true, then toplevel headings are parts,
294
295
# not chapters.
295
- #latex_use_parts = False
296
+ # latex_use_parts = False
296
297
297
298
# If true, show page references after internal links.
298
- #latex_show_pagerefs = False
299
+ # latex_show_pagerefs = False
299
300
300
301
# If true, show URL addresses after external links.
301
- #latex_show_urls = False
302
+ # latex_show_urls = False
302
303
303
304
# Documents to append as an appendix to all manuals.
304
- #latex_appendices = []
305
+ # latex_appendices = []
305
306
306
307
# If false, no module index is generated.
307
- #latex_domain_indices = True
308
+ # latex_domain_indices = True
308
309
309
310
# extlinks alias
310
311
extlinks = {
@@ -329,7 +330,7 @@ def setup(app):
329
330
]
330
331
331
332
# If true, show URL addresses after external links.
332
- #man_show_urls = False
333
+ # man_show_urls = False
333
334
334
335
335
336
# -- Options for Texinfo output -------------------------------------------
@@ -345,16 +346,16 @@ def setup(app):
345
346
]
346
347
347
348
# Documents to append as an appendix to all manuals.
348
- #texinfo_appendices = []
349
+ # texinfo_appendices = []
349
350
350
351
# If false, no module index is generated.
351
- #texinfo_domain_indices = True
352
+ # texinfo_domain_indices = True
352
353
353
354
# How to display URL addresses: 'footnote', 'no', or 'inline'.
354
- #texinfo_show_urls = 'footnote'
355
+ # texinfo_show_urls = 'footnote'
355
356
356
357
# If true, do not generate a @detailmenu in the "Top" node's menu.
357
- #texinfo_no_detailmenu = False
358
+ # texinfo_no_detailmenu = False
358
359
359
360
# Example configuration for intersphinx: refer to the Python standard library.
360
361
intersphinx_mapping = {
0 commit comments