15d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)# Copyright (c) 2014 The Chromium Authors. All rights reserved. 25d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)# Use of this source code is governed by a BSD-style license that can be 35d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)# found in the LICENSE file. 45d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 558537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# -*- coding: utf-8 -*- 658537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# 758537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# Native Client documentation build configuration file, created by 858537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# sphinx-quickstart on Thu Aug 15 11:31:06 2013. 958537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# 1058537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# This file is execfile()d with the current directory set to its containing dir. 1158537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# 1258537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# Note that not all possible configuration values are present in this 1358537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# autogenerated file. 1458537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# 1558537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# All configuration values have a default; values that are commented out 1658537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# serve to show the default. 1758537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) 1858537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)import sys, os 1958537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) 2058537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# Where we keep our extensions... 2158537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)sys.path.insert(0, os.path.abspath('_sphinxext')) 2258537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) 2358537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# -- General configuration ----------------------------------------------------- 2458537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) 2558537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# If your documentation needs a minimal Sphinx version, state it here. 2658537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)#needs_sphinx = '1.0' 2758537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) 2858537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# Add any Sphinx extension module names here, as strings. They can be extensions 2958537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. 305d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)extensions = ['devsite_builder', 'chromesite_builder'] 3158537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) 3258537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# Add any paths that contain templates here, relative to this directory. 3358537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)templates_path = ['_templates'] 3458537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) 3558537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# The suffix of source filenames. 3658537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)source_suffix = '.rst' 3758537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) 3858537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# The encoding of source files. 3958537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)#source_encoding = 'utf-8-sig' 4058537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) 4158537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# The master toctree document. 4258537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)master_doc = 'index' 4358537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) 4458537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# General information about the project. 4558537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)project = u'Native Client' 4658537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) 4758537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# The version info for the project you're documenting, acts as replacement for 4858537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# |version| and |release|, also used in various other places throughout the 4958537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# built documents. 5058537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# 5158537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# The short X.Y version. 5258537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)version = '31' 5358537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# The full version, including alpha/beta/rc tags. 5458537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)release = '31' 5558537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) 5658537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# The language for content autogenerated by Sphinx. Refer to documentation 5758537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# for a list of supported languages. 5858537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)#language = None 5958537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) 6058537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# There are two options for replacing |today|: either, you set today to some 6158537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# non-false value, then it is used: 6258537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)#today = '' 6358537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# Else, today_fmt is used as the format for a strftime call. 6458537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)#today_fmt = '%B %d, %Y' 6558537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) 6658537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# List of patterns, relative to source directory, that match files and 6758537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# directories to ignore when looking for source files. 6868043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles)exclude_patterns = ['_build', '**/.#*'] 6958537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) 7058537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# The reST default role (used for this markup: `text`) to use for all documents. 7158537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)#default_role = None 7258537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) 7358537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# If true, '()' will be appended to :func: etc. cross-reference text. 7458537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)#add_function_parentheses = True 7558537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) 7658537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# If true, the current module name will be prepended to all description 7758537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# unit titles (such as .. function::). 7858537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)#add_module_names = True 7958537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) 8058537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# If true, sectionauthor and moduleauthor directives will be shown in the 8158537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# output. They are ignored by default. 8258537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)#show_authors = False 8358537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) 8458537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# A list of ignored prefixes for module index sorting. 8558537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)#modindex_common_prefix = [] 8658537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) 8758537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# If true, keep warnings as "system message" paragraphs in the built documents. 8858537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)#keep_warnings = False 8958537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) 9058537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) 9158537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# -- Options for HTML output --------------------------------------------------- 9258537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) 9358537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# The theme to use for HTML and HTML Help pages. See the documentation for 9458537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# a list of builtin themes. 9558537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)html_theme = 'default' 9658537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) 9758537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# Theme options are theme-specific and customize the look and feel of a theme 9858537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# further. For a list of options available for each theme, see the 9958537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# documentation. 10058537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)#html_theme_options = {} 10158537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) 10258537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# Add any paths that contain custom themes here, relative to this directory. 10358537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)#html_theme_path = [] 10458537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) 10558537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# The name for this set of Sphinx documents. If None, it defaults to 10658537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# "<project> v<release> documentation". 10758537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)#html_title = None 10858537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) 10958537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# A shorter title for the navigation bar. Default is the same as html_title. 11058537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)#html_short_title = None 11158537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) 11258537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# The name of an image file (relative to this directory) to place at the top 11358537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# of the sidebar. 11458537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)#html_logo = None 11558537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) 11658537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# The name of an image file (within the static path) to use as favicon of the 11758537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 11858537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# pixels large. 11958537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)#html_favicon = None 12058537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) 12158537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# Add any paths that contain custom static files (such as style sheets) here, 12258537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# relative to this directory. They are copied after the builtin static files, 12358537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# so a file named "default.css" will overwrite the builtin "default.css". 1245d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)html_static_path = ['_static'] 12558537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) 12658537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, 12758537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# using the given strftime format. 12858537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)#html_last_updated_fmt = '%b %d, %Y' 12958537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) 13058537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# If true, SmartyPants will be used to convert quotes and dashes to 13158537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# typographically correct entities. 13258537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)html_use_smartypants = True 13358537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) 13458537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# Custom sidebar templates, maps document names to template names. 13558537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)#html_sidebars = {} 13658537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) 13758537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# Additional templates that should be rendered to pages, maps page names to 13858537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# template names. 13958537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)#html_additional_pages = {} 14058537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) 14158537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# If false, no module index is generated. 14258537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)#html_domain_indices = True 14358537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) 14458537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# If false, no index is generated. 14558537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)#html_use_index = True 14658537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) 14758537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# If true, the index is split into individual pages for each letter. 14858537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)#html_split_index = False 14958537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) 15058537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# If true, links to the reST sources are added to the pages. 15158537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)#html_show_sourcelink = True 15258537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) 15358537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. 15458537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)#html_show_sphinx = True 15558537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) 15658537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. 15758537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)#html_show_copyright = True 15858537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) 15958537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# If true, an OpenSearch description file will be output, and all pages will 16058537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# contain a <link> tag referring to it. The value of this option must be the 16158537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# base URL from which the finished HTML is served. 16258537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)#html_use_opensearch = '' 16358537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) 16458537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# This is the file name suffix for HTML files (e.g. ".xhtml"). 16558537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)#html_file_suffix = None 16658537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) 16758537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# Output file base name for HTML help builder. 16858537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)htmlhelp_basename = 'NativeClientdoc' 16958537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) 1704e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles)linkcheck_ignore = [ 1714e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) # General links not worth checking 1724e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) r'http://localhost.*', 1734e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) r'about:.*', 1744e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) r'chrome:.*', 1754e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) r'.*local_extensions\.css', 1764e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) 1774e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) # 1784e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) # Specific known bad cases go here. 1794e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) # 1804e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) 1814e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) # linkcheck's anchor checker can't check these because they are 1824e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) # server-generated and don't actually appear in the HTML of the page. 1834e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) r'https://code.google.com.*browse#svn.*', 1844e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) ] 18558537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) 186