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