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