conf.py
1 # -*- coding: utf-8 -*- 2 # 3 # Adafruit AMG88xx Library documentation build configuration file, created by 4 # sphinx-quickstart on Fri Nov 11 07:42:21 2016. 5 # 6 # This file is execfile()d with the current directory set to its 7 # containing dir. 8 # 9 # Note that not all possible configuration values are present in this 10 # autogenerated file. 11 # 12 # All configuration values have a default; values that are commented out 13 # serve to show the default. 14 15 # If extensions (or modules to document with autodoc) are in another directory, 16 # add these directories to sys.path here. If the directory is relative to the 17 # documentation root, use os.path.abspath to make it absolute, like shown here. 18 # 19 import os 20 import sys 21 22 sys.path.insert(0, os.path.abspath("..")) 23 24 # -- General configuration ------------------------------------------------ 25 26 # If your documentation needs a minimal Sphinx version, state it here. 27 # 28 # needs_sphinx = '1.0' 29 30 # Add any Sphinx extension module names here, as strings. They can be 31 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom 32 # ones. 33 extensions = [ 34 "sphinx.ext.autodoc", 35 "sphinx.ext.intersphinx", 36 "sphinx.ext.viewcode", 37 ] 38 39 # Uncomment the below if you use native CircuitPython modules such as 40 # digitalio, micropython and busio. List the modules you use. Without it, the 41 # autodoc module docs will fail to generate with a warning. 42 # autodoc_mock_imports = ["adafruit_bus_device", "micropython", "adafruit_register"] 43 44 # Add any paths that contain templates here, relative to this directory. 45 templates_path = ["_templates"] 46 47 # The suffix(es) of source filenames. 48 # You can specify multiple suffix as a list of string: 49 # 50 # source_suffix = ['.rst', '.md'] 51 source_suffix = ".rst" 52 53 # The encoding of source files. 54 # 55 # source_encoding = 'utf-8-sig' 56 57 # The master toctree document. 58 master_doc = "index" 59 60 # General information about the project. 61 project = "Adafruit AMG88xx Library" 62 copyright = "2017, Dean Miller for Adafruit Industries" 63 author = "Dean Miller" 64 65 # The version info for the project you're documenting, acts as replacement for 66 # |version| and |release|, also used in various other places throughout the 67 # built documents. 68 # 69 # The short X.Y version. 70 version = "1.0" 71 # The full version, including alpha/beta/rc tags. 72 release = "1.0" 73 74 # The language for content autogenerated by Sphinx. Refer to documentation 75 # for a list of supported languages. 76 # 77 # This is also used if you do content translation via gettext catalogs. 78 # Usually you set "language" from the command line for these cases. 79 language = None 80 81 # There are two options for replacing |today|: either, you set today to some 82 # non-false value, then it is used: 83 # 84 # today = '' 85 # 86 # Else, today_fmt is used as the format for a strftime call. 87 # 88 # today_fmt = '%B %d, %Y' 89 90 # List of patterns, relative to source directory, that match files and 91 # directories to ignore when looking for source files. 92 # This patterns also effect to html_static_path and html_extra_path 93 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", ".env", "CODE_OF_CONDUCT.md"] 94 95 # The reST default role (used for this markup: `text`) to use for all 96 # documents. 97 # 98 default_role = "any" 99 100 # If true, '()' will be appended to :func: etc. cross-reference text. 101 # 102 # add_function_parentheses = True 103 104 # If true, the current module name will be prepended to all description 105 # unit titles (such as .. function::). 106 # 107 # add_module_names = True 108 109 # If true, sectionauthor and moduleauthor directives will be shown in the 110 # output. They are ignored by default. 111 # 112 # show_authors = False 113 114 # The name of the Pygments (syntax highlighting) style to use. 115 pygments_style = "sphinx" 116 117 # If true, `todo` and `todoList` produce output, else they produce nothing. 118 todo_include_todos = False 119 120 # If this is True, todo emits a warning for each TODO entries. The default is False. 121 todo_emit_warnings = True 122 123 # A list of ignored prefixes for module index sorting. 124 # modindex_common_prefix = [] 125 126 # If true, keep warnings as "system message" paragraphs in the built documents. 127 # keep_warnings = False 128 129 # If true, `todo` and `todoList` produce output, else they produce nothing. 130 todo_include_todos = False 131 132 133 # -- Options for HTML output ---------------------------------------------- 134 135 # The theme to use for HTML and HTML Help pages. See the documentation for 136 # a list of builtin themes. 137 # 138 on_rtd = os.environ.get("READTHEDOCS", None) == "True" 139 140 if not on_rtd: # only import and set the theme if we're building docs locally 141 try: 142 import sphinx_rtd_theme 143 144 html_theme = "sphinx_rtd_theme" 145 html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."] 146 except: 147 html_theme = "default" 148 html_theme_path = ["."] 149 else: 150 html_theme_path = ["."] 151 152 # Theme options are theme-specific and customize the look and feel of a theme 153 # further. For a list of options available for each theme, see the 154 # documentation. 155 # 156 # html_theme_options = {} 157 158 # Add any paths that contain custom themes here, relative to this directory. 159 # html_theme_path = [] 160 161 # The name for this set of Sphinx documents. 162 # "<project> v<release> documentation" by default. 163 # 164 # html_title = u'Adafruit AMG88xx Library v1.0' 165 166 # A shorter title for the navigation bar. Default is the same as html_title. 167 # 168 # html_short_title = None 169 170 # The name of an image file (relative to this directory) to place at the top 171 # of the sidebar. 172 # 173 # html_logo = None 174 175 # The name of an image file (relative to this directory) to use as a favicon of 176 # the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 177 # pixels large. 178 # 179 # html_favicon = None 180 181 # Add any paths that contain custom static files (such as style sheets) here, 182 # relative to this directory. They are copied after the builtin static files, 183 # so a file named "default.css" will overwrite the builtin "default.css". 184 html_static_path = ["_static"] 185 186 # Add any extra paths that contain custom files (such as robots.txt or 187 # .htaccess) here, relative to this directory. These files are copied 188 # directly to the root of the documentation. 189 # 190 # html_extra_path = [] 191 192 # If not None, a 'Last updated on:' timestamp is inserted at every page 193 # bottom, using the given strftime format. 194 # The empty string is equivalent to '%b %d, %Y'. 195 # 196 # html_last_updated_fmt = None 197 198 # If true, SmartyPants will be used to convert quotes and dashes to 199 # typographically correct entities. 200 # 201 # html_use_smartypants = True 202 203 # Custom sidebar templates, maps document names to template names. 204 # 205 # html_sidebars = {} 206 207 # Additional templates that should be rendered to pages, maps page names to 208 # template names. 209 # 210 # html_additional_pages = {} 211 212 # If false, no module index is generated. 213 # 214 # html_domain_indices = True 215 216 # If false, no index is generated. 217 # 218 # html_use_index = True 219 220 # If true, the index is split into individual pages for each letter. 221 # 222 # html_split_index = False 223 224 # If true, links to the reST sources are added to the pages. 225 # 226 # html_show_sourcelink = True 227 228 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. 229 # 230 # html_show_sphinx = True 231 232 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. 233 # 234 # html_show_copyright = True 235 236 # If true, an OpenSearch description file will be output, and all pages will 237 # contain a <link> tag referring to it. The value of this option must be the 238 # base URL from which the finished HTML is served. 239 # 240 # html_use_opensearch = '' 241 242 # This is the file name suffix for HTML files (e.g. ".xhtml"). 243 # html_file_suffix = None 244 245 # Language to be used for generating the HTML full-text search index. 246 # Sphinx supports the following languages: 247 # 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' 248 # 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh' 249 # 250 # html_search_language = 'en' 251 252 # A dictionary with options for the search language support, empty by default. 253 # 'ja' uses this config value. 254 # 'zh' user can custom change `jieba` dictionary path. 255 # 256 # html_search_options = {'type': 'default'} 257 258 # The name of a javascript file (relative to the configuration directory) that 259 # implements a search results scorer. If empty, the default will be used. 260 # 261 # html_search_scorer = 'scorer.js' 262 263 # Output file base name for HTML help builder. 264 htmlhelp_basename = "AdafruitAMG88xxLibrarydoc" 265 266 # -- Options for LaTeX output --------------------------------------------- 267 268 latex_elements = { 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', 281 } 282 283 # Grouping the document tree into LaTeX files. List of tuples 284 # (source start file, target name, title, 285 # author, documentclass [howto, manual, or own class]). 286 latex_documents = [ 287 ( 288 master_doc, 289 "AdafruitAMG88xxLibrary.tex", 290 "Adafruit AMG88xx Library Documentation", 291 "Dean Miller", 292 "manual", 293 ), 294 ] 295 296 # The name of an image file (relative to this directory) to place at the top of 297 # the title page. 298 # 299 # latex_logo = None 300 301 # For "manual" documents, if this is true, then toplevel headings are parts, 302 # not chapters. 303 # 304 # latex_use_parts = False 305 306 # If true, show page references after internal links. 307 # 308 # latex_show_pagerefs = False 309 310 # If true, show URL addresses after external links. 311 # 312 # latex_show_urls = False 313 314 # Documents to append as an appendix to all manuals. 315 # 316 # latex_appendices = [] 317 318 # It false, will not define \strong, \code, itleref, \crossref ... but only 319 # \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added 320 # packages. 321 # 322 # latex_keep_old_macro_names = True 323 324 # If false, no module index is generated. 325 # 326 # latex_domain_indices = True 327 328 329 # -- Options for manual page output --------------------------------------- 330 331 # One entry per manual page. List of tuples 332 # (source start file, name, description, authors, manual section). 333 man_pages = [ 334 ( 335 master_doc, 336 "adafruitAMG88xxLibrary", 337 "Adafruit AMG88xx Library Documentation", 338 [author], 339 1, 340 ) 341 ] 342 343 # If true, show URL addresses after external links. 344 # 345 # man_show_urls = False 346 347 348 # -- Options for Texinfo output ------------------------------------------- 349 350 # Grouping the document tree into Texinfo files. List of tuples 351 # (source start file, target name, title, author, 352 # dir menu entry, description, category) 353 texinfo_documents = [ 354 ( 355 master_doc, 356 "AdafruitAMG88xxLibrary", 357 "Adafruit AMG88xx Library Documentation", 358 author, 359 "AdafruitAMG88xxLibrary", 360 "One line description of project.", 361 "Miscellaneous", 362 ), 363 ] 364 365 # Documents to append as an appendix to all manuals. 366 # 367 # texinfo_appendices = [] 368 369 # If false, no module index is generated. 370 # 371 # texinfo_domain_indices = True 372 373 # How to display URL addresses: 'footnote', 'no', or 'inline'. 374 # 375 # texinfo_show_urls = 'footnote' 376 377 # If true, do not generate a @detailmenu in the "Top" node's menu. 378 # 379 # texinfo_no_detailmenu = False 380 381 intersphinx_mapping = { 382 "python": ("https://docs.python.org/3.4", None), 383 "CircuitPython": ("https://circuitpython.readthedocs.io/en/latest/", None), 384 }