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 = [
 14      "sphinx.ext.autodoc",
 15      "sphinx.ext.intersphinx",
 16      "sphinx.ext.viewcode",
 17  ]
 18  
 19  # Uncomment the below if you use native CircuitPython modules such as
 20  # digitalio, micropython and busio. List the modules you use. Without it, the
 21  # autodoc module docs will fail to generate with a warning.
 22  # autodoc_mock_imports = ["micropython"]
 23  
 24  intersphinx_mapping = {
 25      "python": ("https://docs.python.org/3.4", None),
 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 Fingerprint Library"
 39  copyright = "2017 ladyada"
 40  author = "ladyada"
 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  # The name of an image file (relative to this directory) to use as a favicon of
107  # the docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
108  # pixels large.
109  #
110  html_favicon = "_static/favicon.ico"
111  
112  # Output file base name for HTML help builder.
113  htmlhelp_basename = "AdafruitFingerprintLibrarydoc"
114  
115  # -- Options for LaTeX output ---------------------------------------------
116  
117  latex_elements = {
118      # The paper size ('letterpaper' or 'a4paper').
119      #
120      # 'papersize': 'letterpaper',
121      # The font size ('10pt', '11pt' or '12pt').
122      #
123      # 'pointsize': '10pt',
124      # Additional stuff for the LaTeX preamble.
125      #
126      # 'preamble': '',
127      # Latex figure (float) alignment
128      #
129      # 'figure_align': 'htbp',
130  }
131  
132  # Grouping the document tree into LaTeX files. List of tuples
133  # (source start file, target name, title,
134  #  author, documentclass [howto, manual, or own class]).
135  latex_documents = [
136      (
137          master_doc,
138          "AdafruitFingerprintLibrary.tex",
139          "AdafruitFingerprint Library Documentation",
140          author,
141          "manual",
142      ),
143  ]
144  
145  # -- Options for manual page output ---------------------------------------
146  
147  # One entry per manual page. List of tuples
148  # (source start file, name, description, authors, manual section).
149  man_pages = [
150      (
151          master_doc,
152          "AdafruitFingerprintlibrary",
153          "Adafruit Fingerprint Library Documentation",
154          [author],
155          1,
156      )
157  ]
158  
159  # -- Options for Texinfo output -------------------------------------------
160  
161  # Grouping the document tree into Texinfo files. List of tuples
162  # (source start file, target name, title, author,
163  #  dir menu entry, description, category)
164  texinfo_documents = [
165      (
166          master_doc,
167          "AdafruitFingerprintLibrary",
168          "Adafruit Fingerprint Library Documentation",
169          author,
170          "AdafruitFingerprintLibrary",
171          "One line description of project.",
172          "Miscellaneous",
173      ),
174  ]