1# -*- coding: utf-8 -*- 2# 3# devlib documentation build configuration file, created by 4# sphinx-quickstart on Tue Aug 11 17:37:27 2015. 5# 6# This file is execfile()d with the current directory set to its 7# containing dir. 8# 9# Note that not all possible configuration values are present in this 10# autogenerated file. 11# 12# All configuration values have a default; values that are commented out 13# serve to show the default. 14 15import sys 16import os 17import shlex 18 19# If extensions (or modules to document with autodoc) are in another directory, 20# add these directories to sys.path here. If the directory is relative to the 21# documentation root, use os.path.abspath to make it absolute, like shown here. 22#sys.path.insert(0, os.path.abspath('.')) 23 24# -- General configuration ------------------------------------------------ 25 26# If your documentation needs a minimal Sphinx version, state it here. 27#needs_sphinx = '1.0' 28 29# Add any Sphinx extension module names here, as strings. They can be 30# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom 31# ones. 32extensions = [ 33 'sphinx.ext.autodoc', 34 'sphinx.ext.viewcode', 35] 36 37# Add any paths that contain templates here, relative to this directory. 38templates_path = ['static/templates'] 39 40# The suffix(es) of source filenames. 41# You can specify multiple suffix as a list of string: 42# source_suffix = ['.rst', '.md'] 43source_suffix = '.rst' 44 45# The encoding of source files. 46#source_encoding = 'utf-8-sig' 47 48# The master toctree document. 49master_doc = 'index' 50 51# General information about the project. 52project = u'devlib' 53copyright = u'2015, ARM Limited' 54author = u'ARM Limited' 55 56# The version info for the project you're documenting, acts as replacement for 57# |version| and |release|, also used in various other places throughout the 58# built documents. 59# 60# The short X.Y version. 61version = '0.1' 62# The full version, including alpha/beta/rc tags. 63release = '0.1' 64 65# The language for content autogenerated by Sphinx. Refer to documentation 66# for a list of supported languages. 67# 68# This is also used if you do content translation via gettext catalogs. 69# Usually you set "language" from the command line for these cases. 70language = None 71 72# There are two options for replacing |today|: either, you set today to some 73# non-false value, then it is used: 74#today = '' 75# Else, today_fmt is used as the format for a strftime call. 76#today_fmt = '%B %d, %Y' 77 78# List of patterns, relative to source directory, that match files and 79# directories to ignore when looking for source files. 80exclude_patterns = ['../build'] 81 82# The reST default role (used for this markup: `text`) to use for all 83# documents. 84#default_role = None 85 86# If true, '()' will be appended to :func: etc. cross-reference text. 87#add_function_parentheses = True 88 89# If true, the current module name will be prepended to all description 90# unit titles (such as .. function::). 91#add_module_names = True 92 93# If true, sectionauthor and moduleauthor directives will be shown in the 94# output. They are ignored by default. 95#show_authors = False 96 97# The name of the Pygments (syntax highlighting) style to use. 98pygments_style = 'sphinx' 99 100# A list of ignored prefixes for module index sorting. 101#modindex_common_prefix = [] 102 103# If true, keep warnings as "system message" paragraphs in the built documents. 104#keep_warnings = False 105 106# If true, `todo` and `todoList` produce output, else they produce nothing. 107todo_include_todos = False 108 109 110# -- Options for HTML output ---------------------------------------------- 111 112# The theme to use for HTML and HTML Help pages. See the documentation for 113# a list of builtin themes. 114html_theme = 'sphinx_rtd_theme' 115 116# Theme options are theme-specific and customize the look and feel of a theme 117# further. For a list of options available for each theme, see the 118# documentation. 119#html_theme_options = {} 120 121# Add any paths that contain custom themes here, relative to this directory. 122#html_theme_path = [] 123 124# The name for this set of Sphinx documents. If None, it defaults to 125# "<project> v<release> documentation". 126#html_title = None 127 128# A shorter title for the navigation bar. Default is the same as html_title. 129#html_short_title = None 130 131# The name of an image file (relative to this directory) to place at the top 132# of the sidebar. 133#html_logo = None 134 135# The name of an image file (within the static path) to use as favicon of the 136# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 137# pixels large. 138#html_favicon = None 139 140# Add any paths that contain custom static files (such as style sheets) here, 141# relative to this directory. They are copied after the builtin static files, 142# so a file named "default.css" will overwrite the builtin "default.css". 143html_static_path = ['static'] 144 145# Add any extra paths that contain custom files (such as robots.txt or 146# .htaccess) here, relative to this directory. These files are copied 147# directly to the root of the documentation. 148#html_extra_path = [] 149 150# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, 151# using the given strftime format. 152#html_last_updated_fmt = '%b %d, %Y' 153 154# If true, SmartyPants will be used to convert quotes and dashes to 155# typographically correct entities. 156#html_use_smartypants = True 157 158# Custom sidebar templates, maps document names to template names. 159#html_sidebars = {} 160 161# Additional templates that should be rendered to pages, maps page names to 162# template names. 163#html_additional_pages = {} 164 165# If false, no module index is generated. 166#html_domain_indices = True 167 168# If false, no index is generated. 169#html_use_index = True 170 171# If true, the index is split into individual pages for each letter. 172#html_split_index = False 173 174# If true, links to the reST sources are added to the pages. 175#html_show_sourcelink = True 176 177# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. 178#html_show_sphinx = True 179 180# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. 181#html_show_copyright = True 182 183# If true, an OpenSearch description file will be output, and all pages will 184# contain a <link> tag referring to it. The value of this option must be the 185# base URL from which the finished HTML is served. 186#html_use_opensearch = '' 187 188# This is the file name suffix for HTML files (e.g. ".xhtml"). 189#html_file_suffix = None 190 191# Language to be used for generating the HTML full-text search index. 192# Sphinx supports the following languages: 193# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' 194# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' 195#html_search_language = 'en' 196 197# A dictionary with options for the search language support, empty by default. 198# Now only 'ja' uses this config value 199#html_search_options = {'type': 'default'} 200 201# The name of a javascript file (relative to the configuration directory) that 202# implements a search results scorer. If empty, the default will be used. 203#html_search_scorer = 'scorer.js' 204 205# Output file base name for HTML help builder. 206htmlhelp_basename = 'devlibdoc' 207 208# -- Options for LaTeX output --------------------------------------------- 209 210latex_elements = { 211# The paper size ('letterpaper' or 'a4paper'). 212#'papersize': 'letterpaper', 213 214# The font size ('10pt', '11pt' or '12pt'). 215#'pointsize': '10pt', 216 217# Additional stuff for the LaTeX preamble. 218#'preamble': '', 219 220# Latex figure (float) alignment 221#'figure_align': 'htbp', 222} 223 224# Grouping the document tree into LaTeX files. List of tuples 225# (source start file, target name, title, 226# author, documentclass [howto, manual, or own class]). 227latex_documents = [ 228 (master_doc, 'devlib.tex', u'devlib Documentation', 229 u'ARM Limited', 'manual'), 230] 231 232# The name of an image file (relative to this directory) to place at the top of 233# the title page. 234#latex_logo = None 235 236# For "manual" documents, if this is true, then toplevel headings are parts, 237# not chapters. 238#latex_use_parts = False 239 240# If true, show page references after internal links. 241#latex_show_pagerefs = False 242 243# If true, show URL addresses after external links. 244#latex_show_urls = False 245 246# Documents to append as an appendix to all manuals. 247#latex_appendices = [] 248 249# If false, no module index is generated. 250#latex_domain_indices = True 251 252 253# -- Options for manual page output --------------------------------------- 254 255# One entry per manual page. List of tuples 256# (source start file, name, description, authors, manual section). 257man_pages = [ 258 (master_doc, 'devlib', u'devlib Documentation', 259 [author], 1) 260] 261 262# If true, show URL addresses after external links. 263#man_show_urls = False 264 265 266# -- Options for Texinfo output ------------------------------------------- 267 268# Grouping the document tree into Texinfo files. List of tuples 269# (source start file, target name, title, author, 270# dir menu entry, description, category) 271texinfo_documents = [ 272 (master_doc, 'devlib', u'devlib Documentation', 273 author, 'devlib', 'One line description of project.', 274 'Miscellaneous'), 275] 276 277# Documents to append as an appendix to all manuals. 278#texinfo_appendices = [] 279 280# If false, no module index is generated. 281#texinfo_domain_indices = True 282 283# How to display URL addresses: 'footnote', 'no', or 'inline'. 284#texinfo_show_urls = 'footnote' 285 286# If true, do not generate a @detailmenu in the "Top" node's menu. 287#texinfo_no_detailmenu = False 288