|
18 | 18 | #
|
19 | 19 | import os
|
20 | 20 | import sys
|
21 |
| -sys.path.insert(0, os.path.abspath('..')) |
| 21 | + |
| 22 | +sys.path.insert(0, os.path.abspath("..")) |
22 | 23 |
|
23 | 24 | # -- General configuration ------------------------------------------------
|
24 | 25 |
|
|
30 | 31 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
31 | 32 | # ones.
|
32 | 33 | extensions = [
|
33 |
| - 'sphinx.ext.autodoc', |
34 |
| - 'sphinx.ext.intersphinx', |
35 |
| - 'sphinx.ext.viewcode', |
| 34 | + "sphinx.ext.autodoc", |
| 35 | + "sphinx.ext.intersphinx", |
| 36 | + "sphinx.ext.viewcode", |
36 | 37 | ]
|
37 | 38 |
|
38 | 39 | # Uncomment the below if you use native CircuitPython modules such as
|
|
41 | 42 | # autodoc_mock_imports = ["adafruit_bus_device", "micropython", "adafruit_register"]
|
42 | 43 |
|
43 | 44 | # Add any paths that contain templates here, relative to this directory.
|
44 |
| -templates_path = ['_templates'] |
| 45 | +templates_path = ["_templates"] |
45 | 46 |
|
46 | 47 | # The suffix(es) of source filenames.
|
47 | 48 | # You can specify multiple suffix as a list of string:
|
48 | 49 | #
|
49 | 50 | # source_suffix = ['.rst', '.md']
|
50 |
| -source_suffix = '.rst' |
| 51 | +source_suffix = ".rst" |
51 | 52 |
|
52 | 53 | # The encoding of source files.
|
53 | 54 | #
|
54 | 55 | # source_encoding = 'utf-8-sig'
|
55 | 56 |
|
56 | 57 | # The master toctree document.
|
57 |
| -master_doc = 'index' |
| 58 | +master_doc = "index" |
58 | 59 |
|
59 | 60 | # General information about the project.
|
60 |
| -project = u'Adafruit AMG88xx Library' |
61 |
| -copyright = u'2017, Dean Miller for Adafruit Industries' |
62 |
| -author = u'Dean Miller' |
| 61 | +project = u"Adafruit AMG88xx Library" |
| 62 | +copyright = u"2017, Dean Miller for Adafruit Industries" |
| 63 | +author = u"Dean Miller" |
63 | 64 |
|
64 | 65 | # The version info for the project you're documenting, acts as replacement for
|
65 | 66 | # |version| and |release|, also used in various other places throughout the
|
66 | 67 | # built documents.
|
67 | 68 | #
|
68 | 69 | # The short X.Y version.
|
69 |
| -version = u'1.0' |
| 70 | +version = u"1.0" |
70 | 71 | # The full version, including alpha/beta/rc tags.
|
71 |
| -release = u'1.0' |
| 72 | +release = u"1.0" |
72 | 73 |
|
73 | 74 | # The language for content autogenerated by Sphinx. Refer to documentation
|
74 | 75 | # for a list of supported languages.
|
|
89 | 90 | # List of patterns, relative to source directory, that match files and
|
90 | 91 | # directories to ignore when looking for source files.
|
91 | 92 | # This patterns also effect to html_static_path and html_extra_path
|
92 |
| -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '.env', 'CODE_OF_CONDUCT.md'] |
| 93 | +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", ".env", "CODE_OF_CONDUCT.md"] |
93 | 94 |
|
94 | 95 | # The reST default role (used for this markup: `text`) to use for all
|
95 | 96 | # documents.
|
|
111 | 112 | # show_authors = False
|
112 | 113 |
|
113 | 114 | # The name of the Pygments (syntax highlighting) style to use.
|
114 |
| -pygments_style = 'sphinx' |
| 115 | +pygments_style = "sphinx" |
115 | 116 |
|
116 | 117 | # If true, `todo` and `todoList` produce output, else they produce nothing.
|
117 | 118 | todo_include_todos = False
|
|
134 | 135 | # The theme to use for HTML and HTML Help pages. See the documentation for
|
135 | 136 | # a list of builtin themes.
|
136 | 137 | #
|
137 |
| -on_rtd = os.environ.get('READTHEDOCS', None) == 'True' |
| 138 | +on_rtd = os.environ.get("READTHEDOCS", None) == "True" |
138 | 139 |
|
139 | 140 | if not on_rtd: # only import and set the theme if we're building docs locally
|
140 | 141 | try:
|
141 | 142 | import sphinx_rtd_theme
|
142 |
| - html_theme = 'sphinx_rtd_theme' |
143 |
| - html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), '.'] |
| 143 | + |
| 144 | + html_theme = "sphinx_rtd_theme" |
| 145 | + html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."] |
144 | 146 | except:
|
145 |
| - html_theme = 'default' |
146 |
| - html_theme_path = ['.'] |
| 147 | + html_theme = "default" |
| 148 | + html_theme_path = ["."] |
147 | 149 | else:
|
148 |
| - html_theme_path = ['.'] |
| 150 | + html_theme_path = ["."] |
149 | 151 |
|
150 | 152 | # Theme options are theme-specific and customize the look and feel of a theme
|
151 | 153 | # further. For a list of options available for each theme, see the
|
|
179 | 181 | # Add any paths that contain custom static files (such as style sheets) here,
|
180 | 182 | # relative to this directory. They are copied after the builtin static files,
|
181 | 183 | # so a file named "default.css" will overwrite the builtin "default.css".
|
182 |
| -html_static_path = ['_static'] |
| 184 | +html_static_path = ["_static"] |
183 | 185 |
|
184 | 186 | # Add any extra paths that contain custom files (such as robots.txt or
|
185 | 187 | # .htaccess) here, relative to this directory. These files are copied
|
|
259 | 261 | # html_search_scorer = 'scorer.js'
|
260 | 262 |
|
261 | 263 | # Output file base name for HTML help builder.
|
262 |
| -htmlhelp_basename = 'AdafruitAMG88xxLibrarydoc' |
| 264 | +htmlhelp_basename = "AdafruitAMG88xxLibrarydoc" |
263 | 265 |
|
264 | 266 | # -- Options for LaTeX output ---------------------------------------------
|
265 | 267 |
|
266 | 268 | latex_elements = {
|
267 |
| - # The paper size ('letterpaper' or 'a4paper'). |
268 |
| - # |
269 |
| - # 'papersize': 'letterpaper', |
270 |
| - |
271 |
| - # The font size ('10pt', '11pt' or '12pt'). |
272 |
| - # |
273 |
| - # 'pointsize': '10pt', |
274 |
| - |
275 |
| - # Additional stuff for the LaTeX preamble. |
276 |
| - # |
277 |
| - # 'preamble': '', |
278 |
| - |
279 |
| - # Latex figure (float) alignment |
280 |
| - # |
281 |
| - # 'figure_align': 'htbp', |
| 269 | + # The paper size ('letterpaper' or 'a4paper'). |
| 270 | + # |
| 271 | + # 'papersize': 'letterpaper', |
| 272 | + # The font size ('10pt', '11pt' or '12pt'). |
| 273 | + # |
| 274 | + # 'pointsize': '10pt', |
| 275 | + # Additional stuff for the LaTeX preamble. |
| 276 | + # |
| 277 | + # 'preamble': '', |
| 278 | + # Latex figure (float) alignment |
| 279 | + # |
| 280 | + # 'figure_align': 'htbp', |
282 | 281 | }
|
283 | 282 |
|
284 | 283 | # Grouping the document tree into LaTeX files. List of tuples
|
285 | 284 | # (source start file, target name, title,
|
286 | 285 | # author, documentclass [howto, manual, or own class]).
|
287 | 286 | latex_documents = [
|
288 |
| - (master_doc, 'AdafruitAMG88xxLibrary.tex', u'Adafruit AMG88xx Library Documentation', |
289 |
| - u'Dean Miller', 'manual'), |
| 287 | + ( |
| 288 | + master_doc, |
| 289 | + "AdafruitAMG88xxLibrary.tex", |
| 290 | + u"Adafruit AMG88xx Library Documentation", |
| 291 | + u"Dean Miller", |
| 292 | + "manual", |
| 293 | + ), |
290 | 294 | ]
|
291 | 295 |
|
292 | 296 | # The name of an image file (relative to this directory) to place at the top of
|
|
327 | 331 | # One entry per manual page. List of tuples
|
328 | 332 | # (source start file, name, description, authors, manual section).
|
329 | 333 | man_pages = [
|
330 |
| - (master_doc, 'adafruitAMG88xxLibrary', u'Adafruit AMG88xx Library Documentation', |
331 |
| - [author], 1) |
| 334 | + ( |
| 335 | + master_doc, |
| 336 | + "adafruitAMG88xxLibrary", |
| 337 | + u"Adafruit AMG88xx Library Documentation", |
| 338 | + [author], |
| 339 | + 1, |
| 340 | + ) |
332 | 341 | ]
|
333 | 342 |
|
334 | 343 | # If true, show URL addresses after external links.
|
|
342 | 351 | # (source start file, target name, title, author,
|
343 | 352 | # dir menu entry, description, category)
|
344 | 353 | texinfo_documents = [
|
345 |
| - (master_doc, 'AdafruitAMG88xxLibrary', u'Adafruit AMG88xx Library Documentation', |
346 |
| - author, 'AdafruitAMG88xxLibrary', 'One line description of project.', |
347 |
| - 'Miscellaneous'), |
| 354 | + ( |
| 355 | + master_doc, |
| 356 | + "AdafruitAMG88xxLibrary", |
| 357 | + u"Adafruit AMG88xx Library Documentation", |
| 358 | + author, |
| 359 | + "AdafruitAMG88xxLibrary", |
| 360 | + "One line description of project.", |
| 361 | + "Miscellaneous", |
| 362 | + ), |
348 | 363 | ]
|
349 | 364 |
|
350 | 365 | # Documents to append as an appendix to all manuals.
|
|
363 | 378 | #
|
364 | 379 | # texinfo_no_detailmenu = False
|
365 | 380 |
|
366 |
| -intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None), |
367 |
| - 'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)} |
| 381 | +intersphinx_mapping = { |
| 382 | + "python": ("https://docs.python.org/3.4", None), |
| 383 | + "CircuitPython": ("https://circuitpython.readthedocs.io/en/latest/", None), |
| 384 | +} |
0 commit comments