|
4 | 4 | import sys
|
5 | 5 |
|
6 | 6 |
|
7 | | -sys.path.insert(0, os.path.abspath('..')) |
| 7 | +sys.path.insert(0, os.path.abspath("..")) |
8 | 8 |
|
9 | 9 |
|
10 | 10 | from webexteamssdk._version import get_versions
|
11 | 11 |
|
12 | 12 |
|
13 | | -project = u'webexteamssdk' |
14 | | -copyright = u'Copyright (c) 2016-2020 Cisco and/or its affiliates.' |
15 | | -author = u'Chris Lunsford' |
16 | | -version = get_versions()['version'] |
17 | | -release = get_versions()['version'] |
| 13 | +project = "webexteamssdk" |
| 14 | +copyright = "Copyright (c) 2016-2024 Cisco and/or its affiliates." |
| 15 | +author = "Chris Lunsford" |
| 16 | +version = get_versions()["version"] |
| 17 | +release = get_versions()["version"] |
18 | 18 | language = None
|
19 | 19 |
|
20 | 20 |
|
21 | 21 | extensions = [
|
22 | | - 'sphinx.ext.autodoc', |
23 | | - 'sphinx.ext.doctest', |
24 | | - 'sphinx.ext.intersphinx', |
25 | | - 'sphinx.ext.todo', |
26 | | - 'sphinx.ext.coverage', |
27 | | - 'sphinx.ext.viewcode', |
28 | | - 'sphinx.ext.napoleon', |
| 22 | + "sphinx.ext.autodoc", |
| 23 | + "sphinx.ext.doctest", |
| 24 | + "sphinx.ext.intersphinx", |
| 25 | + "sphinx.ext.todo", |
| 26 | + "sphinx.ext.coverage", |
| 27 | + "sphinx.ext.viewcode", |
| 28 | + "sphinx.ext.napoleon", |
29 | 29 | ]
|
30 | 30 |
|
31 | 31 |
|
32 | | -master_doc = 'index' |
33 | | -source_suffix = '.rst' |
34 | | -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] |
35 | | -templates_path = ['_templates'] |
36 | | -pygments_style = 'sphinx' |
| 32 | +master_doc = "index" |
| 33 | +source_suffix = ".rst" |
| 34 | +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] |
| 35 | +templates_path = ["_templates"] |
| 36 | +pygments_style = "sphinx" |
37 | 37 |
|
38 | 38 |
|
39 | 39 | add_module_names = False
|
40 | | -autodoc_member_order = 'bysource' |
| 40 | +autodoc_member_order = "bysource" |
41 | 41 | # autodoc_default_flags = ['members', 'undoc-members']
|
42 | 42 | autodoc_default_options = {
|
43 | | - 'members': None, |
44 | | - 'undoc-members': None, |
| 43 | + "members": None, |
| 44 | + "undoc-members": None, |
45 | 45 | }
|
46 | 46 |
|
47 | 47 |
|
48 | 48 | todo_include_todos = True
|
49 | 49 |
|
50 | 50 |
|
51 | | - |
52 | 51 | # -- Options for HTML output ----------------------------------------------
|
53 | 52 |
|
54 | 53 | # The theme to use for HTML and HTML Help pages. See the documentation for
|
55 | 54 | # a list of builtin themes.
|
56 | 55 | #
|
57 | | -#html_theme = 'alabaster' |
58 | | -on_rtd = os.environ.get('READTHEDOCS', None) == 'True' |
| 56 | +#html_theme = 'alabaster' |
| 57 | +on_rtd = os.environ.get("READTHEDOCS", None) == "True" |
59 | 58 |
|
60 | 59 | if not on_rtd:
|
61 | 60 | import sphinx_rtd_theme
|
62 | | - html_theme = 'sphinx_rtd_theme' |
| 61 | + |
| 62 | + html_theme = "sphinx_rtd_theme" |
63 | 63 | html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
|
64 | 64 |
|
65 | 65 | # Theme options are theme-specific and customize the look and feel of a theme
|
66 | 66 | # further. For a list of options available for each theme, see the
|
67 | 67 | # documentation.
|
68 | 68 | #
|
69 | | -html_theme_options = { |
70 | | - 'collapse_navigation': False |
71 | | -} |
| 69 | +html_theme_options = {"collapse_navigation": False} |
72 | 70 |
|
73 | 71 | # Add any paths that contain custom themes here, relative to this directory.
|
74 | 72 | # html_theme_path = []
|
|
176 | 174 | # html_search_scorer = 'scorer.js'
|
177 | 175 |
|
178 | 176 | # Output file base name for HTML help builder.
|
179 | | -htmlhelp_basename = 'webexteamssdkdoc' |
180 | | - |
| 177 | +htmlhelp_basename = "webexteamssdkdoc" |
181 | 178 |
|
182 | 179 |
|
183 | 180 | # -- Options for LaTeX output ---------------------------------------------
|
184 | 181 |
|
185 | 182 | latex_elements = {
|
186 | | - # The paper size ('letterpaper' or 'a4paper'). |
187 | | - # |
188 | | - # 'papersize': 'letterpaper', |
189 | | - |
190 | | - # The font size ('10pt', '11pt' or '12pt'). |
191 | | - # |
192 | | - # 'pointsize': '10pt', |
193 | | - |
194 | | - # Additional stuff for the LaTeX preamble. |
195 | | - # |
196 | | - # 'preamble': '', |
197 | | - |
198 | | - # Latex figure (float) alignment |
199 | | - # |
200 | | - # 'figure_align': 'htbp', |
| 183 | + # The paper size ('letterpaper' or 'a4paper'). |
| 184 | + # |
| 185 | + # 'papersize': 'letterpaper', |
| 186 | + # The font size ('10pt', '11pt' or '12pt'). |
| 187 | + # |
| 188 | + # 'pointsize': '10pt', |
| 189 | + # Additional stuff for the LaTeX preamble. |
| 190 | + # |
| 191 | + # 'preamble': '', |
| 192 | + # Latex figure (float) alignment |
| 193 | + # |
| 194 | + # 'figure_align': 'htbp', |
201 | 195 | }
|
202 | 196 |
|
203 | 197 | # Grouping the document tree into LaTeX files. List of tuples
|
204 | 198 | # (source start file, target name, title,
|
205 | 199 | # author, documentclass [howto, manual, or own class]).
|
206 | 200 | latex_documents = [
|
207 | | - (master_doc, 'webexteamssdk.tex', u'webexteamssdk Documentation', |
208 | | - u'Chris Lunsford', 'manual'), |
| 201 | + ( |
| 202 | + master_doc, |
| 203 | + "webexteamssdk.tex", |
| 204 | + "webexteamssdk Documentation", |
| 205 | + "Chris Lunsford", |
| 206 | + "manual", |
| 207 | + ), |
209 | 208 | ]
|
210 | 209 |
|
211 | 210 | # The name of an image file (relative to this directory) to place at the top of
|
|
241 | 240 | # latex_domain_indices = True
|
242 | 241 |
|
243 | 242 |
|
244 | | - |
245 | 243 | # -- Options for manual page output ---------------------------------------
|
246 | 244 |
|
247 | 245 | # One entry per manual page. List of tuples
|
248 | 246 | # (source start file, name, description, authors, manual section).
|
249 | 247 | man_pages = [
|
250 | | - (master_doc, 'webexteamssdk', u'webexteamssdk Documentation', |
251 | | - [author], 1) |
| 248 | + (master_doc, "webexteamssdk", "webexteamssdk Documentation", [author], 1) |
252 | 249 | ]
|
253 | 250 |
|
254 | 251 | # If true, show URL addresses after external links.
|
255 | 252 | #
|
256 | 253 | # man_show_urls = False
|
257 | 254 |
|
258 | 255 |
|
259 | | - |
260 | 256 | # -- Options for Texinfo output -------------------------------------------
|
261 | 257 |
|
262 | 258 | # Grouping the document tree into Texinfo files. List of tuples
|
263 | 259 | # (source start file, target name, title, author,
|
264 | 260 | # dir menu entry, description, category)
|
265 | 261 | texinfo_documents = [
|
266 | | - (master_doc, 'webexteamssdk', u'webexteamssdk Documentation', |
267 | | - author, 'webexteamssdk', 'One line description of project.', |
268 | | - 'Miscellaneous'), |
| 262 | + ( |
| 263 | + master_doc, |
| 264 | + "webexteamssdk", |
| 265 | + "webexteamssdk Documentation", |
| 266 | + author, |
| 267 | + "webexteamssdk", |
| 268 | + "One line description of project.", |
| 269 | + "Miscellaneous", |
| 270 | + ), |
269 | 271 | ]
|
270 | 272 |
|
271 | 273 | # Documents to append as an appendix to all manuals.
|
|
286 | 288 |
|
287 | 289 |
|
288 | 290 | # Example configuration for intersphinx: refer to the Python standard library.
|
289 | | -intersphinx_mapping = {'https://docs.python.org/': None} |
| 291 | +intersphinx_mapping = {"https://docs.python.org/": None} |
0 commit comments