docs/conf.py

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