docs/conf.py

   1 # -*- coding: utf-8 -*-
   2
   3 import os
   4 import sys
   5 sys.path.insert(0, os.path.abspath('../src'))
   6
   7 # -- General configuration ------------------------------------------------
   8
   9 # Add any Sphinx extension module names here, as strings. They can be
  10 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
  11 # ones.
  12 extensions = [
  13     'sphinx.ext.autodoc',
  14     'sphinx.ext.intersphinx',
  15     'sphinx.ext.todo',
  16 ]
  17
  18 # Uncomment the below if you use native CircuitPython modules such as
  19 # digitalio, micropython and busio. List the modules you use. Without it, the
  20 # autodoc module docs will fail to generate with a warning.
  21 autodoc_mock_imports = ["machine"]
  22
  23 intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),
  24                        'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)}
  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 = u'Adafruit Blinka Library'
  36 copyright = u'2017 cefn'
  37 author = u'cefn'
  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 = u'1.0.0'
  45 # The full version, including alpha/beta/rc tags.
  46 release = u'1.0.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         html_theme = 'sphinx_rtd_theme'
  90         html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), '.']
  91     except:
  92         html_theme = 'default'
  93         html_theme_path = ['.']
  94 else:
  95     html_theme_path = ['.']
  96
  97 # Add any paths that contain custom static files (such as style sheets) here,
  98 # relative to this directory. They are copied after the builtin static files,
  99 # so a file named "default.css" will overwrite the builtin "default.css".
 100 html_static_path = ['_static']
 101
 102 # Output file base name for HTML help builder.
 103 htmlhelp_basename = 'AdafruitBlinkaLibrarydoc'
 104
 105 # -- Options for LaTeX output ---------------------------------------------
 106
 107 latex_elements = {
 108      # The paper size ('letterpaper' or 'a4paper').
 109      #
 110      # 'papersize': 'letterpaper',
 111
 112      # The font size ('10pt', '11pt' or '12pt').
 113      #
 114      # 'pointsize': '10pt',
 115
 116      # Additional stuff for the LaTeX preamble.
 117      #
 118      # 'preamble': '',
 119
 120      # Latex figure (float) alignment
 121      #
 122      # 'figure_align': 'htbp',
 123 }
 124
 125 # Grouping the document tree into LaTeX files. List of tuples
 126 # (source start file, target name, title,
 127 #  author, documentclass [howto, manual, or own class]).
 128 latex_documents = [
 129     (master_doc, 'AdafruitBlinkaLibrary.tex', u'AdafruitBlinka Library Documentation',
 130      author, 'manual'),
 131 ]
 132
 133 # -- Options for manual page output ---------------------------------------
 134
 135 # One entry per manual page. List of tuples
 136 # (source start file, name, description, authors, manual section).
 137 man_pages = [
 138     (master_doc, 'AdafruitBlinkalibrary', u'Adafruit Blinka Library Documentation',
 139      [author], 1)
 140 ]
 141
 142 # -- Options for Texinfo output -------------------------------------------
 143
 144 # Grouping the document tree into Texinfo files. List of tuples
 145 # (source start file, target name, title, author,
 146 #  dir menu entry, description, category)
 147 texinfo_documents = [
 148     (master_doc, 'AdafruitBlinkaLibrary', u'Adafruit Blinka Library Documentation',
 149      author, 'AdafruitBlinkaLibrary', 'One line description of project.',
 150      'Miscellaneous'),
 151 ]