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