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