docs/conf.py

   1 # -*- coding: utf-8 -*-
   2
   3 import os
   4 import sys
   5
   6 sys.path.insert(0, os.path.abspath("../src"))
   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 = ["machine", "Adafruit_GPIO"]
  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 Blinka Library"
  39 copyright = "2017 cefn"
  40 author = "cefn"
  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.0"
  48 # The full version, including alpha/beta/rc tags.
  49 release = "1.0.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 # Output file base name for HTML help builder.
 107 htmlhelp_basename = "AdafruitBlinkaLibrarydoc"
 108
 109 # -- Options for LaTeX output ---------------------------------------------
 110
 111 latex_elements = {
 112     # The paper size ('letterpaper' or 'a4paper').
 113     #
 114     # 'papersize': 'letterpaper',
 115     # The font size ('10pt', '11pt' or '12pt').
 116     #
 117     # 'pointsize': '10pt',
 118     # Additional stuff for the LaTeX preamble.
 119     #
 120     # 'preamble': '',
 121     # Latex figure (float) alignment
 122     #
 123     # 'figure_align': 'htbp',
 124 }
 125
 126 # Grouping the document tree into LaTeX files. List of tuples
 127 # (source start file, target name, title,
 128 #  author, documentclass [howto, manual, or own class]).
 129 latex_documents = [
 130     (
 131         master_doc,
 132         "AdafruitBlinkaLibrary.tex",
 133         "AdafruitBlinka Library Documentation",
 134         author,
 135         "manual",
 136     ),
 137 ]
 138
 139 # -- Options for manual page output ---------------------------------------
 140
 141 # One entry per manual page. List of tuples
 142 # (source start file, name, description, authors, manual section).
 143 man_pages = [
 144     (
 145         master_doc,
 146         "AdafruitBlinkalibrary",
 147         "Adafruit Blinka Library Documentation",
 148         [author],
 149         1,
 150     )
 151 ]
 152
 153 # -- Options for Texinfo output -------------------------------------------
 154
 155 # Grouping the document tree into Texinfo files. List of tuples
 156 # (source start file, target name, title, author,
 157 #  dir menu entry, description, category)
 158 texinfo_documents = [
 159     (
 160         master_doc,
 161         "AdafruitBlinkaLibrary",
 162         "Adafruit Blinka Library Documentation",
 163         author,
 164         "AdafruitBlinkaLibrary",
 165         "One line description of project.",
 166         "Miscellaneous",
 167     ),
 168 ]