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