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