| 
2 | 2 | 
 
  | 
3 | 3 | import os  | 
4 | 4 | import sys  | 
5 |  | -sys.path.insert(0, os.path.abspath('..'))  | 
 | 5 | + | 
 | 6 | +sys.path.insert(0, os.path.abspath(".."))  | 
6 | 7 | 
 
  | 
7 | 8 | # -- General configuration ------------------------------------------------  | 
8 | 9 | 
 
  | 
9 | 10 | # Add any Sphinx extension module names here, as strings. They can be  | 
10 | 11 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom  | 
11 | 12 | # ones.  | 
12 | 13 | extensions = [  | 
13 |  | -    'sphinx.ext.autodoc',  | 
14 |  | -    'sphinx.ext.intersphinx',  | 
15 |  | -    'sphinx.ext.viewcode',  | 
 | 14 | +    "sphinx.ext.autodoc",  | 
 | 15 | +    "sphinx.ext.intersphinx",  | 
 | 16 | +    "sphinx.ext.viewcode",  | 
16 | 17 | ]  | 
17 | 18 | 
 
  | 
18 | 19 | # Uncomment the below if you use native CircuitPython modules such as  | 
19 | 20 | # digitalio, micropython and busio. List the modules you use. Without it, the  | 
20 | 21 | # autodoc module docs will fail to generate with a warning.  | 
21 | 22 | # autodoc_mock_imports = ["digitalio"]  | 
22 | 23 | 
 
  | 
23 |  | -intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)}  | 
 | 24 | +intersphinx_mapping = {  | 
 | 25 | +    "python": ("https://docs.python.org/3.4", None),  | 
 | 26 | +    "CircuitPython": ("https://circuitpython.readthedocs.io/en/latest/", None),  | 
 | 27 | +}  | 
24 | 28 | 
 
  | 
25 | 29 | # Add any paths that contain templates here, relative to this directory.  | 
26 |  | -templates_path = ['_templates']  | 
 | 30 | +templates_path = ["_templates"]  | 
27 | 31 | 
 
  | 
28 |  | -source_suffix = '.rst'  | 
 | 32 | +source_suffix = ".rst"  | 
29 | 33 | 
 
  | 
30 | 34 | # The master toctree document.  | 
31 |  | -master_doc = 'index'  | 
 | 35 | +master_doc = "index"  | 
32 | 36 | 
 
  | 
33 | 37 | # General information about the project.  | 
34 |  | -project = u'Adafruit AVRprog Library'  | 
35 |  | -copyright = u'2017 ladyada'  | 
36 |  | -author = u'ladyada'  | 
 | 38 | +project = u"Adafruit AVRprog Library"  | 
 | 39 | +copyright = u"2017 ladyada"  | 
 | 40 | +author = u"ladyada"  | 
37 | 41 | 
 
  | 
38 | 42 | # The version info for the project you're documenting, acts as replacement for  | 
39 | 43 | # |version| and |release|, also used in various other places throughout the  | 
40 | 44 | # built documents.  | 
41 | 45 | #  | 
42 | 46 | # The short X.Y version.  | 
43 |  | -version = u'1.0'  | 
 | 47 | +version = u"1.0"  | 
44 | 48 | # The full version, including alpha/beta/rc tags.  | 
45 |  | -release = u'1.0'  | 
 | 49 | +release = u"1.0"  | 
46 | 50 | 
 
  | 
47 | 51 | # The language for content autogenerated by Sphinx. Refer to documentation  | 
48 | 52 | # for a list of supported languages.  | 
 | 
54 | 58 | # List of patterns, relative to source directory, that match files and  | 
55 | 59 | # directories to ignore when looking for source files.  | 
56 | 60 | # This patterns also effect to html_static_path and html_extra_path  | 
57 |  | -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '.env', 'CODE_OF_CONDUCT.md']  | 
 | 61 | +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", ".env", "CODE_OF_CONDUCT.md"]  | 
58 | 62 | 
 
  | 
59 | 63 | # The reST default role (used for this markup: `text`) to use for all  | 
60 | 64 | # documents.  | 
 | 
66 | 70 | add_function_parentheses = True  | 
67 | 71 | 
 
  | 
68 | 72 | # The name of the Pygments (syntax highlighting) style to use.  | 
69 |  | -pygments_style = 'sphinx'  | 
 | 73 | +pygments_style = "sphinx"  | 
70 | 74 | 
 
  | 
71 | 75 | # If true, `todo` and `todoList` produce output, else they produce nothing.  | 
72 | 76 | todo_include_todos = False  | 
 | 
80 | 84 | # The theme to use for HTML and HTML Help pages.  See the documentation for  | 
81 | 85 | # a list of builtin themes.  | 
82 | 86 | #  | 
83 |  | -on_rtd = os.environ.get('READTHEDOCS', None) == 'True'  | 
 | 87 | +on_rtd = os.environ.get("READTHEDOCS", None) == "True"  | 
84 | 88 | 
 
  | 
85 | 89 | if not on_rtd:  # only import and set the theme if we're building docs locally  | 
86 | 90 |     try:  | 
87 | 91 |         import sphinx_rtd_theme  | 
88 |  | -        html_theme = 'sphinx_rtd_theme'  | 
89 |  | -        html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), '.']  | 
 | 92 | + | 
 | 93 | +        html_theme = "sphinx_rtd_theme"  | 
 | 94 | +        html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."]  | 
90 | 95 |     except:  | 
91 |  | -        html_theme = 'default'  | 
92 |  | -        html_theme_path = ['.']  | 
 | 96 | +        html_theme = "default"  | 
 | 97 | +        html_theme_path = ["."]  | 
93 | 98 | else:  | 
94 |  | -    html_theme_path = ['.']  | 
 | 99 | +    html_theme_path = ["."]  | 
95 | 100 | 
 
  | 
96 | 101 | # Add any paths that contain custom static files (such as style sheets) here,  | 
97 | 102 | # relative to this directory. They are copied after the builtin static files,  | 
98 | 103 | # so a file named "default.css" will overwrite the builtin "default.css".  | 
99 |  | -html_static_path = ['_static']  | 
 | 104 | +html_static_path = ["_static"]  | 
100 | 105 | 
 
  | 
101 | 106 | # The name of an image file (relative to this directory) to use as a favicon of  | 
102 | 107 | # the docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32  | 
103 | 108 | # pixels large.  | 
104 | 109 | #  | 
105 |  | -html_favicon = '_static/favicon.ico'  | 
 | 110 | +html_favicon = "_static/favicon.ico"  | 
106 | 111 | 
 
  | 
107 | 112 | # Output file base name for HTML help builder.  | 
108 |  | -htmlhelp_basename = 'AdafruitAvrprogLibrarydoc'  | 
 | 113 | +htmlhelp_basename = "AdafruitAvrprogLibrarydoc"  | 
109 | 114 | 
 
  | 
110 | 115 | # -- Options for LaTeX output ---------------------------------------------  | 
111 | 116 | 
 
  | 
112 | 117 | latex_elements = {  | 
113 |  | -     # The paper size ('letterpaper' or 'a4paper').  | 
114 |  | -     #  | 
115 |  | -     # 'papersize': 'letterpaper',  | 
116 |  | - | 
117 |  | -     # The font size ('10pt', '11pt' or '12pt').  | 
118 |  | -     #  | 
119 |  | -     # 'pointsize': '10pt',  | 
120 |  | - | 
121 |  | -     # Additional stuff for the LaTeX preamble.  | 
122 |  | -     #  | 
123 |  | -     # 'preamble': '',  | 
124 |  | - | 
125 |  | -     # Latex figure (float) alignment  | 
126 |  | -     #  | 
127 |  | -     # 'figure_align': 'htbp',  | 
 | 118 | +    # The paper size ('letterpaper' or 'a4paper').  | 
 | 119 | +    #  | 
 | 120 | +    # 'papersize': 'letterpaper',  | 
 | 121 | +    # The font size ('10pt', '11pt' or '12pt').  | 
 | 122 | +    #  | 
 | 123 | +    # 'pointsize': '10pt',  | 
 | 124 | +    # Additional stuff for the LaTeX preamble.  | 
 | 125 | +    #  | 
 | 126 | +    # 'preamble': '',  | 
 | 127 | +    # Latex figure (float) alignment  | 
 | 128 | +    #  | 
 | 129 | +    # 'figure_align': 'htbp',  | 
128 | 130 | }  | 
129 | 131 | 
 
  | 
130 | 132 | # Grouping the document tree into LaTeX files. List of tuples  | 
131 | 133 | # (source start file, target name, title,  | 
132 | 134 | #  author, documentclass [howto, manual, or own class]).  | 
133 | 135 | latex_documents = [  | 
134 |  | -    (master_doc, 'AdafruitAVRprogLibrary.tex', u'AdafruitAVRprog Library Documentation',  | 
135 |  | -     author, 'manual'),  | 
 | 136 | +    (  | 
 | 137 | +        master_doc,  | 
 | 138 | +        "AdafruitAVRprogLibrary.tex",  | 
 | 139 | +        u"AdafruitAVRprog Library Documentation",  | 
 | 140 | +        author,  | 
 | 141 | +        "manual",  | 
 | 142 | +    ),  | 
136 | 143 | ]  | 
137 | 144 | 
 
  | 
138 | 145 | # -- Options for manual page output ---------------------------------------  | 
139 | 146 | 
 
  | 
140 | 147 | # One entry per manual page. List of tuples  | 
141 | 148 | # (source start file, name, description, authors, manual section).  | 
142 | 149 | man_pages = [  | 
143 |  | -    (master_doc, 'AdafruitAVRproglibrary', u'Adafruit AVRprog Library Documentation',  | 
144 |  | -     [author], 1)  | 
 | 150 | +    (  | 
 | 151 | +        master_doc,  | 
 | 152 | +        "AdafruitAVRproglibrary",  | 
 | 153 | +        u"Adafruit AVRprog Library Documentation",  | 
 | 154 | +        [author],  | 
 | 155 | +        1,  | 
 | 156 | +    )  | 
145 | 157 | ]  | 
146 | 158 | 
 
  | 
147 | 159 | # -- Options for Texinfo output -------------------------------------------  | 
 | 
150 | 162 | # (source start file, target name, title, author,  | 
151 | 163 | #  dir menu entry, description, category)  | 
152 | 164 | texinfo_documents = [  | 
153 |  | -    (master_doc, 'AdafruitAVRprogLibrary', u'Adafruit AVRprog Library Documentation',  | 
154 |  | -     author, 'AdafruitAVRprogLibrary', 'One line description of project.',  | 
155 |  | -     'Miscellaneous'),  | 
 | 165 | +    (  | 
 | 166 | +        master_doc,  | 
 | 167 | +        "AdafruitAVRprogLibrary",  | 
 | 168 | +        u"Adafruit AVRprog Library Documentation",  | 
 | 169 | +        author,  | 
 | 170 | +        "AdafruitAVRprogLibrary",  | 
 | 171 | +        "One line description of project.",  | 
 | 172 | +        "Miscellaneous",  | 
 | 173 | +    ),  | 
156 | 174 | ]  | 
0 commit comments