1765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#!/usr/bin/env python3 2765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# -*- coding: utf-8 -*- 3765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# 4765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# . documentation build configuration file, created by 5765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# sphinx-quickstart on Thu May 1 18:34:23 2014. 6765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# 7765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# This file is execfile()d with the current directory set to its 8765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# containing dir. 9765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# 10765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# Note that not all possible configuration values are present in this 11765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# autogenerated file. 12765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# 13765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# All configuration values have a default; values that are commented out 14765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# serve to show the default. 15765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 16765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhangimport sys 17765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhangimport os 18765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhangimport shlex 19765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 20765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# If extensions (or modules to document with autodoc) are in another directory, 21765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# add these directories to sys.path here. If the directory is relative to the 22765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# documentation root, use os.path.abspath to make it absolute, like shown here. 23765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhangsys.path.insert(0, "@CMAKE_CURRENT_BINARY_DIR@/pyupm/") 24765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhangsys.path.insert(0, "@MRAA_LIBDIR@@LIB_SUFFIX@") 25765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 26765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# -- General configuration ------------------------------------------------ 27765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 28765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# Custom flags and filters if needed 29765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# autodoc_default_flags = ['members', 'private-members', 'special-members', 'undoc-members', 'show-inheritance'] 30765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 31765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# def autodoc_skip_member(app, what, name, obj, skip, options): 32765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang # exclusions = ('__weakref__', # special-members 33765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang # '__doc__', '__module__', '__dict__', # undoc-members 34765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang # 'swig_import_helper' 35765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang # ) 36765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang # exclude = name in exclusions 37765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang # return skip or exclude 38765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 39765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# def setup(app): 40765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang # app.connect('autodoc-skip-member', autodoc_skip_member) 41765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 42765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# If your documentation needs a minimal Sphinx version, state it here. 43765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#needs_sphinx = '1.0' 44765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 45765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# Add any Sphinx extension module names here, as strings. They can be 46765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom 47765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# ones. 48765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhangextensions = [ 49765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 'sphinx.ext.autodoc', 50765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 'sphinx.ext.todo', 51765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 'sphinx.ext.viewcode', 52765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang] 53765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 54765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# Add any paths that contain templates here, relative to this directory. 55765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhangtemplates_path = ['_templates'] 56765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 57765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# The suffix of source filenames. 58765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhangsource_suffix = '.rst' 59765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 60765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# The encoding of source files. 61765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#source_encoding = 'utf-8-sig' 62765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 63765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# The master toctree document. 64765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhangmaster_doc = 'index' 65765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 66765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# General information about the project. 67765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhangproject = 'upm' 68765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhangcopyright = '2015, Intel Corporation' 69765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 70765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# The version info for the project you're documenting, acts as replacement for 71765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# |version| and |release|, also used in various other places throughout the 72765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# built documents. 73765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# 74765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# The short X.Y version. 75765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhangversion = '@upm_VERSION_STRING@' 76765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# The full version, including alpha/beta/rc tags. 77765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhangrelease = '@VERSION@' 78765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 79765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# The language for content autogenerated by Sphinx. Refer to documentation 80765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# for a list of supported languages. 81765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#language = None 82765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 83765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# There are two options for replacing |today|: either, you set today to some 84765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# non-false value, then it is used: 85765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#today = '' 86765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# Else, today_fmt is used as the format for a strftime call. 87765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#today_fmt = '%B %d, %Y' 88765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 89765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# List of patterns, relative to source directory, that match files and 90765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# directories to ignore when looking for source files. 91765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhangexclude_patterns = ['_build', '**/.git', '**/CMakeFiles/**', '**/CMakeLists.txt'] 92765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 93765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# The reST default role (used for this markup: `text`) to use for all 94765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# documents. 95765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#default_role = None 96765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 97765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# If true, '()' will be appended to :func: etc. cross-reference text. 98765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#add_function_parentheses = True 99765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 100765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# If true, the current module name will be prepended to all description 101765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# unit titles (such as .. function::). 102765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#add_module_names = True 103765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 104765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# If true, sectionauthor and moduleauthor directives will be shown in the 105765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# output. They are ignored by default. 106765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#show_authors = False 107765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 108765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# The name of the Pygments (syntax highlighting) style to use. 109765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhangpygments_style = 'sphinx' 110765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 111765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# A list of ignored prefixes for module index sorting. 112765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#modindex_common_prefix = [] 113765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 114765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# If true, keep warnings as "system message" paragraphs in the built documents. 115765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#keep_warnings = False 116765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 117765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# If true, `todo` and `todoList` produce output, else they produce nothing. 118765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhangtodo_include_todos = True 119765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 120765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# -- Options for HTML output ---------------------------------------------- 121765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 122765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# The theme to use for HTML and HTML Help pages. See the documentation for 123765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# a list of builtin themes. 124765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhanghtml_theme = 'default' 125765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#html_theme = '@SPHINX_THEME@' 126765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 127765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# Theme options are theme-specific and customize the look and feel of a theme 128765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# further. For a list of options available for each theme, see the 129765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# documentation. 130765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#html_theme_options = {} 131765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 132765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# Add any paths that contain custom themes here, relative to this directory. 133765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#html_theme_path = ['@SPHINX_THEME_DIR@'] 134765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 135765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# The name for this set of Sphinx documents. If None, it defaults to 136765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# "<project> v<release> documentation". 137765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#html_title = None 138765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 139765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# A shorter title for the navigation bar. Default is the same as html_title. 140765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#html_short_title = None 141765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 142765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# The name of an image file (relative to this directory) to place at the top 143765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# of the sidebar. 144765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#html_logo = None 145765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 146765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# The name of an image file (within the static path) to use as favicon of the 147765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 148765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# pixels large. 149765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#html_favicon = None 150765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 151765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# Add any paths that contain custom static files (such as style sheets) here, 152765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# relative to this directory. They are copied after the builtin static files, 153765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# so a file named "default.css" will overwrite the builtin "default.css". 154765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhanghtml_static_path = ['_static'] 155765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 156765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# Add any extra paths that contain custom files (such as robots.txt or 157765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# .htaccess) here, relative to this directory. These files are copied 158765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# directly to the root of the documentation. 159765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#html_extra_path = [] 160765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 161765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, 162765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# using the given strftime format. 163765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#html_last_updated_fmt = '%b %d, %Y' 164765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 165765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# If true, SmartyPants will be used to convert quotes and dashes to 166765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# typographically correct entities. 167765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#html_use_smartypants = True 168765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 169765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# Custom sidebar templates, maps document names to template names. 170765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#html_sidebars = {} 171765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 172765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# Additional templates that should be rendered to pages, maps page names to 173765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# template names. 174765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#html_additional_pages = {} 175765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 176765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# If false, no module index is generated. 177765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#html_domain_indices = True 178765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 179765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# If false, no index is generated. 180765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#html_use_index = True 181765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 182765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# If true, the index is split into individual pages for each letter. 183765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#html_split_index = False 184765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 185765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# If true, links to the reST sources are added to the pages. 186765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#html_show_sourcelink = True 187765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 188765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. 189765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#html_show_sphinx = True 190765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 191765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. 192765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#html_show_copyright = True 193765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 194765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# If true, an OpenSearch description file will be output, and all pages will 195765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# contain a <link> tag referring to it. The value of this option must be the 196765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# base URL from which the finished HTML is served. 197765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#html_use_opensearch = '' 198765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 199765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# This is the file name suffix for HTML files (e.g. ".xhtml"). 200765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#html_file_suffix = None 201765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 202765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# Output file base name for HTML help builder. 203765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhanghtmlhelp_basename = 'upmdoc' 204765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 205765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 206765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# -- Options for LaTeX output --------------------------------------------- 207765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 208765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhanglatex_elements = { 209765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# The paper size ('letterpaper' or 'a4paper'). 210765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#'papersize': 'letterpaper', 211765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 212765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# The font size ('10pt', '11pt' or '12pt'). 213765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#'pointsize': '10pt', 214765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 215765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# Additional stuff for the LaTeX preamble. 216765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#'preamble': '', 217765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang} 218765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 219765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# Grouping the document tree into LaTeX files. List of tuples 220765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# (source start file, target name, title, 221765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# author, documentclass [howto, manual, or own class]). 222765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhanglatex_documents = [ 223765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang ('index', 'sphinx.tex', '. Documentation', 224765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 'Author', 'manual'), 225765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang] 226765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 227765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# The name of an image file (relative to this directory) to place at the top of 228765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# the title page. 229765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#latex_logo = None 230765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 231765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# For "manual" documents, if this is true, then toplevel headings are parts, 232765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# not chapters. 233765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#latex_use_parts = False 234765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 235765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# If true, show page references after internal links. 236765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#latex_show_pagerefs = False 237765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 238765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# If true, show URL addresses after external links. 239765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#latex_show_urls = False 240765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 241765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# Documents to append as an appendix to all manuals. 242765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#latex_appendices = [] 243765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 244765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# If false, no module index is generated. 245765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#latex_domain_indices = True 246765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 247765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 248765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# -- Options for manual page output --------------------------------------- 249765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 250765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# One entry per manual page. List of tuples 251765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# (source start file, name, description, authors, manual section). 252765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhangman_pages = [ 253765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang ('index', 'sphinx', '. Documentation', 254765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang ['Author'], 1) 255765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang] 256765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 257765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# If true, show URL addresses after external links. 258765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#man_show_urls = False 259765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 260765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 261765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# -- Options for Texinfo output ------------------------------------------- 262765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 263765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# Grouping the document tree into Texinfo files. List of tuples 264765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# (source start file, target name, title, author, 265765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# dir menu entry, description, category) 266765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhangtexinfo_documents = [ 267765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang ('index', 'sphinx', '. Documentation', 268765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 'Author', 'sphinx', 'One line description of project.', 269765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 'Miscellaneous'), 270765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang] 271765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 272765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# Documents to append as an appendix to all manuals. 273765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#texinfo_appendices = [] 274765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 275765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# If false, no module index is generated. 276765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#texinfo_domain_indices = True 277765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 278765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# How to display URL addresses: 'footnote', 'no', or 'inline'. 279765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#texinfo_show_urls = 'footnote' 280765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 281765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# If true, do not generate a @detailmenu in the "Top" node's menu. 282765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#texinfo_no_detailmenu = False 283765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 284765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 285765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# -- Options for Epub output ---------------------------------------------- 286765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 287765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# Bibliographic Dublin Core info. 288765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhangepub_title = '.' 289765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhangepub_author = 'UPM' 290765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhangepub_publisher = 'UPM' 291765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhangepub_copyright = '2015, Intel Corporation' 292765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 293765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# The basename for the epub file. It defaults to the project name. 294765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#epub_basename = '.' 295765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 296765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# The HTML theme for the epub output. Since the default themes are not optimized 297765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# for small screen space, using the same theme for HTML and epub output is 298765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# usually not wise. This defaults to 'epub', a theme designed to save visual 299765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# space. 300765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#epub_theme = 'epub' 301765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 302765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# The language of the text. It defaults to the language option 303765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# or en if the language is not set. 304765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#epub_language = '' 305765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 306765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# The scheme of the identifier. Typical schemes are ISBN or URL. 307765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#epub_scheme = '' 308765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 309765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# The unique identifier of the text. This can be a ISBN number 310765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# or the project homepage. 311765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#epub_identifier = '' 312765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 313765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# A unique identification for the text. 314765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#epub_uid = '' 315765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 316765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# A tuple containing the cover image and cover page html template filenames. 317765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#epub_cover = () 318765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 319765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# A sequence of (type, uri, title) tuples for the guide element of content.opf. 320765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#epub_guide = () 321765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 322765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# HTML files that should be inserted before the pages created by sphinx. 323765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# The format is a list of tuples containing the path and title. 324765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#epub_pre_files = [] 325765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 326765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# HTML files shat should be inserted after the pages created by sphinx. 327765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# The format is a list of tuples containing the path and title. 328765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#epub_post_files = [] 329765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 330765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# A list of files that should not be packed into the epub file. 331765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhangepub_exclude_files = ['search.html'] 332765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 333765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# The depth of the table of contents in toc.ncx. 334765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#epub_tocdepth = 3 335765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 336765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# Allow duplicate toc entries. 337765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#epub_tocdup = True 338765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 339765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# Choose between 'default' and 'includehidden'. 340765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#epub_tocscope = 'default' 341765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 342765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# Fix unsupported image types using the PIL. 343765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#epub_fix_images = False 344765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 345765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# Scale large images. 346765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#epub_max_image_width = 0 347765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 348765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# How to display URL addresses: 'footnote', 'no', or 'inline'. 349765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#epub_show_urls = 'inline' 350765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang 351765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang# If false, no index is generated. 352765adb95dc941c32690d6c43bc08b9d07d197fcbJianxun Zhang#epub_use_index = True 353