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