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