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