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.todo",
 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 = ["digitalio", "busio", "ustruct", "micropython", "adafruit_bus_device"]
 23  
 24  intersphinx_mapping = {
 25      "python": ("https://docs.python.org/3.4", None),
 26      "BusDevice": (
 27          "https://circuitpython.readthedocs.io/projects/busdevice/en/latest/",
 28          None,
 29      ),
 30      "CircuitPython": ("https://circuitpython.readthedocs.io/en/latest/", None),
 31  }
 32  
 33  # Add any paths that contain templates here, relative to this directory.
 34  templates_path = ["_templates"]
 35  
 36  source_suffix = ".rst"
 37  
 38  # The master toctree document.
 39  master_doc = "index"
 40  
 41  # General information about the project.
 42  project = "Adafruit SI5351 Library"
 43  copyright = "2017 Tony DiCola"
 44  author = "Tony DiCola"
 45  
 46  # The version info for the project you're documenting, acts as replacement for
 47  # |version| and |release|, also used in various other places throughout the
 48  # built documents.
 49  #
 50  # The short X.Y version.
 51  version = "1.0"
 52  # The full version, including alpha/beta/rc tags.
 53  release = "1.0"
 54  
 55  # The language for content autogenerated by Sphinx. Refer to documentation
 56  # for a list of supported languages.
 57  #
 58  # This is also used if you do content translation via gettext catalogs.
 59  # Usually you set "language" from the command line for these cases.
 60  language = None
 61  
 62  # List of patterns, relative to source directory, that match files and
 63  # directories to ignore when looking for source files.
 64  # This patterns also effect to html_static_path and html_extra_path
 65  exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", ".env", "CODE_OF_CONDUCT.md"]
 66  
 67  # The reST default role (used for this markup: `text`) to use for all
 68  # documents.
 69  #
 70  default_role = "any"
 71  
 72  # If true, '()' will be appended to :func: etc. cross-reference text.
 73  #
 74  add_function_parentheses = True
 75  
 76  # The name of the Pygments (syntax highlighting) style to use.
 77  pygments_style = "sphinx"
 78  
 79  # If true, `todo` and `todoList` produce output, else they produce nothing.
 80  todo_include_todos = False
 81  
 82  # If this is True, todo emits a warning for each TODO entries. The default is False.
 83  todo_emit_warnings = True
 84  
 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  # Output file base name for HTML help builder.
111  htmlhelp_basename = "AdafruitSi5351Librarydoc"
112  
113  # -- Options for LaTeX output ---------------------------------------------
114  
115  latex_elements = {
116      # The paper size ('letterpaper' or 'a4paper').
117      #
118      # 'papersize': 'letterpaper',
119      # The font size ('10pt', '11pt' or '12pt').
120      #
121      # 'pointsize': '10pt',
122      # Additional stuff for the LaTeX preamble.
123      #
124      # 'preamble': '',
125      # Latex figure (float) alignment
126      #
127      # 'figure_align': 'htbp',
128  }
129  
130  # Grouping the document tree into LaTeX files. List of tuples
131  # (source start file, target name, title,
132  #  author, documentclass [howto, manual, or own class]).
133  latex_documents = [
134      (
135          master_doc,
136          "AdafruitSI5351Library.tex",
137          "AdafruitSI5351 Library Documentation",
138          author,
139          "manual",
140      ),
141  ]
142  
143  # -- Options for manual page output ---------------------------------------
144  
145  # One entry per manual page. List of tuples
146  # (source start file, name, description, authors, manual section).
147  man_pages = [
148      (
149          master_doc,
150          "AdafruitSI5351library",
151          "Adafruit SI5351 Library Documentation",
152          [author],
153          1,
154      )
155  ]
156  
157  # -- Options for Texinfo output -------------------------------------------
158  
159  # Grouping the document tree into Texinfo files. List of tuples
160  # (source start file, target name, title, author,
161  #  dir menu entry, description, category)
162  texinfo_documents = [
163      (
164          master_doc,
165          "AdafruitSI5351Library",
166          "Adafruit SI5351 Library Documentation",
167          author,
168          "AdafruitSI5351Library",
169          "One line description of project.",
170          "Miscellaneous",
171      ),
172  ]