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