1 # Copyright (c) 2014 The Chromium Authors. All rights reserved. 2 # Use of this source code is governed by a BSD-style license that can be 3 # found in the LICENSE file. 4 5 # -*- coding: utf-8 -*- 6 # 7 # Native Client documentation build configuration file, created by 8 # sphinx-quickstart on Thu Aug 15 11:31:06 2013. 9 # 10 # This file is execfile()d with the current directory set to its containing dir. 11 # 12 # Note that not all possible configuration values are present in this 13 # autogenerated file. 14 # 15 # All configuration values have a default; values that are commented out 16 # serve to show the default. 17 18 import sys, os 19 20 # Where we keep our extensions... 21 sys.path.insert(0, os.path.abspath('_sphinxext')) 22 23 # -- General configuration ----------------------------------------------------- 24 25 # If your documentation needs a minimal Sphinx version, state it here. 26 #needs_sphinx = '1.0' 27 28 # Add any Sphinx extension module names here, as strings. They can be extensions 29 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. 30 extensions = ['devsite_builder', 'chromesite_builder'] 31 32 # Add any paths that contain templates here, relative to this directory. 33 templates_path = ['_templates'] 34 35 # The suffix of source filenames. 36 source_suffix = '.rst' 37 38 # The encoding of source files. 39 #source_encoding = 'utf-8-sig' 40 41 # The master toctree document. 42 master_doc = 'index' 43 44 # General information about the project. 45 project = u'Native Client' 46 47 # The version info for the project you're documenting, acts as replacement for 48 # |version| and |release|, also used in various other places throughout the 49 # built documents. 50 # 51 # The short X.Y version. 52 version = '31' 53 # The full version, including alpha/beta/rc tags. 54 release = '31' 55 56 # The language for content autogenerated by Sphinx. Refer to documentation 57 # for a list of supported languages. 58 #language = None 59 60 # There are two options for replacing |today|: either, you set today to some 61 # non-false value, then it is used: 62 #today = '' 63 # Else, today_fmt is used as the format for a strftime call. 64 #today_fmt = '%B %d, %Y' 65 66 # List of patterns, relative to source directory, that match files and 67 # directories to ignore when looking for source files. 68 exclude_patterns = ['_build', '**/.#*'] 69 70 # The reST default role (used for this markup: `text`) to use for all documents. 71 #default_role = None 72 73 # If true, '()' will be appended to :func: etc. cross-reference text. 74 #add_function_parentheses = True 75 76 # If true, the current module name will be prepended to all description 77 # unit titles (such as .. function::). 78 #add_module_names = True 79 80 # If true, sectionauthor and moduleauthor directives will be shown in the 81 # output. They are ignored by default. 82 #show_authors = False 83 84 # A list of ignored prefixes for module index sorting. 85 #modindex_common_prefix = [] 86 87 # If true, keep warnings as "system message" paragraphs in the built documents. 88 #keep_warnings = False 89 90 91 # -- Options for HTML output --------------------------------------------------- 92 93 # The theme to use for HTML and HTML Help pages. See the documentation for 94 # a list of builtin themes. 95 html_theme = 'default' 96 97 # Theme options are theme-specific and customize the look and feel of a theme 98 # further. For a list of options available for each theme, see the 99 # documentation. 100 #html_theme_options = {} 101 102 # Add any paths that contain custom themes here, relative to this directory. 103 #html_theme_path = [] 104 105 # The name for this set of Sphinx documents. If None, it defaults to 106 # "<project> v<release> documentation". 107 #html_title = None 108 109 # A shorter title for the navigation bar. Default is the same as html_title. 110 #html_short_title = None 111 112 # The name of an image file (relative to this directory) to place at the top 113 # of the sidebar. 114 #html_logo = None 115 116 # The name of an image file (within the static path) to use as favicon of the 117 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 118 # pixels large. 119 #html_favicon = None 120 121 # Add any paths that contain custom static files (such as style sheets) here, 122 # relative to this directory. They are copied after the builtin static files, 123 # so a file named "default.css" will overwrite the builtin "default.css". 124 html_static_path = ['_static'] 125 126 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, 127 # using the given strftime format. 128 #html_last_updated_fmt = '%b %d, %Y' 129 130 # If true, SmartyPants will be used to convert quotes and dashes to 131 # typographically correct entities. 132 html_use_smartypants = True 133 134 # Custom sidebar templates, maps document names to template names. 135 #html_sidebars = {} 136 137 # Additional templates that should be rendered to pages, maps page names to 138 # template names. 139 #html_additional_pages = {} 140 141 # If false, no module index is generated. 142 #html_domain_indices = True 143 144 # If false, no index is generated. 145 #html_use_index = True 146 147 # If true, the index is split into individual pages for each letter. 148 #html_split_index = False 149 150 # If true, links to the reST sources are added to the pages. 151 #html_show_sourcelink = True 152 153 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. 154 #html_show_sphinx = True 155 156 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. 157 #html_show_copyright = True 158 159 # If true, an OpenSearch description file will be output, and all pages will 160 # contain a <link> tag referring to it. The value of this option must be the 161 # base URL from which the finished HTML is served. 162 #html_use_opensearch = '' 163 164 # This is the file name suffix for HTML files (e.g. ".xhtml"). 165 #html_file_suffix = None 166 167 # Output file base name for HTML help builder. 168 htmlhelp_basename = 'NativeClientdoc' 169 170 linkcheck_ignore = [ 171 # General links not worth checking 172 r'http://localhost.*', 173 r'about:.*', 174 r'chrome:.*', 175 r'.*local_extensions\.css', 176 177 # 178 # Specific known bad cases go here. 179 # 180 181 # linkcheck's anchor checker can't check these because they are 182 # server-generated and don't actually appear in the HTML of the page. 183 r'https://code.google.com.*browse#svn.*', 184 ] 185 186