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