docs/source/conf.py

   1 # -*- coding: utf-8 -*-
   2 #
   3 # Configuration file for the Sphinx documentation builder.
   4 #
   5 # This file does only contain a selection of the most common options. For a
   6 # full list see the documentation:
   7 # http://www.sphinx-doc.org/en/master/config
   8
   9 # -- Path setup --------------------------------------------------------------
  10
  11 # If extensions (or modules to document with autodoc) are in another directory,
  12 # add these directories to sys.path here. If the directory is relative to the
  13 # documentation root, use os.path.abspath to make it absolute, like shown here.
  14 #
  15 # import os
  16 # import sys
  17 # sys.path.insert(0, os.path.abspath('.'))
  18
  19
  20 # -- Project information -----------------------------------------------------
  21
  22 project = u'ELIOT-Edge Lightweight IoT'
  23 copyright = u'2020, ELIOT Authors'
  24 author = u'ELIOT Authors'
  25
  26 # The short X.Y version
  27 version = u''
  28 # The full version, including alpha/beta/rc tags
  29 release = u'0.0.3'
  30
  31
  32 # -- General configuration ---------------------------------------------------
  33
  34 # If your documentation needs a minimal Sphinx version, state it here.
  35 #
  36 # needs_sphinx = '1.0'
  37
  38 # Add any Sphinx extension module names here, as strings. They can be
  39 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
  40 # ones.
  41 extensions = [
  42     'sphinx.ext.autodoc',
  43 ]
  44
  45 # Add any paths that contain templates here, relative to this directory.
  46 templates_path = ['_templates']
  47
  48 # The suffix(es) of source filenames.
  49 # You can specify multiple suffix as a list of string:
  50 #
  51 # source_suffix = ['.rst', '.md']
  52 source_suffix = '.rst'
  53
  54 # The master toctree document.
  55 master_doc = 'index'
  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 = None
  63
  64 # List of patterns, relative to source directory, that match files and
  65 # directories to ignore when looking for source files.
  66 # This pattern also affects html_static_path and html_extra_path.
  67 exclude_patterns = [u'_build', 'proposals', 'Thumbs.db', '.DS_Store']
  68
  69 # The name of the Pygments (syntax highlighting) style to use.
  70 pygments_style = 'sphinx'
  71
  72
  73 # -- Options for HTML output -------------------------------------------------
  74
  75 # The theme to use for HTML and HTML Help pages.  See the documentation for
  76 # a list of builtin themes.
  77 #
  78 html_theme = 'sphinx_rtd_theme'
  79
  80 # Theme options are theme-specific and customize the look and feel of a theme
  81 # further.  For a list of options available for each theme, see the
  82 # documentation.
  83 #
  84 html_theme_options = {
  85     'prev_next_buttons_location': 'both'
  86 }
  87
  88 # Add any paths that contain custom static files (such as style sheets) here,
  89 # relative to this directory. They are copied after the builtin static files,
  90 # so a file named "default.css" will overwrite the builtin "default.css".
  91 html_static_path = ['_static']
  92
  93 # Custom sidebar templates, must be a dictionary that maps document names
  94 # to template names.
  95 #
  96 # The default sidebars (for documents that don't match any pattern) are
  97 # defined by theme itself.  Builtin themes are using these templates by
  98 # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
  99 # 'searchbox.html']``.
 100 #
 101 # html_sidebars = {}
 102
 103
 104 # -- Options for HTMLHelp output ---------------------------------------------
 105
 106 # Output file base name for HTML help builder.
 107 htmlhelp_basename = 'ELIOT-EdgeLightweightIoTdoc'
 108
 109
 110 # -- Options for LaTeX output ------------------------------------------------
 111
 112 latex_elements = {
 113     # The paper size ('letterpaper' or 'a4paper').
 114     #
 115     # 'papersize': 'letterpaper',
 116
 117     # The font size ('10pt', '11pt' or '12pt').
 118     #
 119     # 'pointsize': '10pt',
 120
 121     # Additional stuff for the LaTeX preamble.
 122     #
 123     # 'preamble': '',
 124
 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     (master_doc, 'ELIOT-EdgeLightweightIoT.tex', u'ELIOT-Edge Lightweight IoT',
 135      u'ELIOT Authors', '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     (master_doc, 'eliot-edgelightweightiot', u'ELIOT-Edge Lightweight IoT',
 145      [author], 1)
 146 ]
 147
 148
 149 # -- Options for Texinfo output ----------------------------------------------
 150
 151 # Grouping the document tree into Texinfo files. List of tuples
 152 # (source start file, target name, title, author,
 153 #  dir menu entry, description, category)
 154 texinfo_documents = [
 155     (master_doc, 'ELIOT-EdgeLightweightIoT', u'ELIOT-Edge Lightweight IoT',
 156      author, 'ELIOT-EdgeLightweightIoT', 'One line description of project.',
 157      'Miscellaneous'),
 158 ]
 159
 160
 161 # -- Options for Epub output -------------------------------------------------
 162
 163 # Bibliographic Dublin Core info.
 164 epub_title = project
 165
 166 # The unique identifier of the text. This can be a ISBN number
 167 # or the project homepage.
 168 #
 169 # epub_identifier = ''
 170
 171 # A unique identification for the text.
 172 #
 173 # epub_uid = ''
 174
 175 # A list of files that should not be packed into the epub file.
 176 epub_exclude_files = ['search.html']
 177
 178
 179 # -- Extension configuration -------------------------------------------------