1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/testing/marionette/client/docs/conf.py Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,246 @@
1.4 +# -*- coding: utf-8 -*-
1.5 +#
1.6 +# Marionette Python Client documentation build configuration file, created by
1.7 +# sphinx-quickstart on Tue Aug 6 13:54:46 2013.
1.8 +#
1.9 +# This file is execfile()d with the current directory set to its containing dir.
1.10 +#
1.11 +# Note that not all possible configuration values are present in this
1.12 +# autogenerated file.
1.13 +#
1.14 +# All configuration values have a default; values that are commented out
1.15 +# serve to show the default.
1.16 +
1.17 +import sys, os
1.18 +
1.19 +# If extensions (or modules to document with autodoc) are in another directory,
1.20 +# add these directories to sys.path here. If the directory is relative to the
1.21 +# documentation root, use os.path.abspath to make it absolute, like shown here.
1.22 +#sys.path.insert(0, os.path.abspath('.'))
1.23 +
1.24 +here = os.path.dirname(os.path.abspath(__file__))
1.25 +parent = os.path.dirname(here)
1.26 +sys.path.insert(0, parent)
1.27 +
1.28 +# -- General configuration -----------------------------------------------------
1.29 +
1.30 +# If your documentation needs a minimal Sphinx version, state it here.
1.31 +#needs_sphinx = '1.0'
1.32 +
1.33 +# Add any Sphinx extension module names here, as strings. They can be extensions
1.34 +# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
1.35 +extensions = ['sphinx.ext.autodoc']
1.36 +
1.37 +# Add any paths that contain templates here, relative to this directory.
1.38 +templates_path = ['_templates']
1.39 +
1.40 +# The suffix of source filenames.
1.41 +source_suffix = '.rst'
1.42 +
1.43 +# The encoding of source files.
1.44 +#source_encoding = 'utf-8-sig'
1.45 +
1.46 +# The master toctree document.
1.47 +master_doc = 'index'
1.48 +
1.49 +# General information about the project.
1.50 +project = u'Marionette Python Client'
1.51 +copyright = u'2013, Mozilla Automation and Tools and individual contributors'
1.52 +
1.53 +# The version info for the project you're documenting, acts as replacement for
1.54 +# |version| and |release|, also used in various other places throughout the
1.55 +# built documents.
1.56 +#
1.57 +# The short X.Y version.
1.58 +#version = '0'
1.59 +# The full version, including alpha/beta/rc tags.
1.60 +#release = '0'
1.61 +
1.62 +# The language for content autogenerated by Sphinx. Refer to documentation
1.63 +# for a list of supported languages.
1.64 +#language = None
1.65 +
1.66 +# There are two options for replacing |today|: either, you set today to some
1.67 +# non-false value, then it is used:
1.68 +#today = ''
1.69 +# Else, today_fmt is used as the format for a strftime call.
1.70 +#today_fmt = '%B %d, %Y'
1.71 +
1.72 +# List of patterns, relative to source directory, that match files and
1.73 +# directories to ignore when looking for source files.
1.74 +exclude_patterns = ['_build']
1.75 +
1.76 +# The reST default role (used for this markup: `text`) to use for all documents.
1.77 +#default_role = None
1.78 +
1.79 +# If true, '()' will be appended to :func: etc. cross-reference text.
1.80 +#add_function_parentheses = True
1.81 +
1.82 +# If true, the current module name will be prepended to all description
1.83 +# unit titles (such as .. function::).
1.84 +#add_module_names = True
1.85 +
1.86 +# If true, sectionauthor and moduleauthor directives will be shown in the
1.87 +# output. They are ignored by default.
1.88 +#show_authors = False
1.89 +
1.90 +# The name of the Pygments (syntax highlighting) style to use.
1.91 +pygments_style = 'sphinx'
1.92 +
1.93 +# A list of ignored prefixes for module index sorting.
1.94 +#modindex_common_prefix = []
1.95 +
1.96 +
1.97 +# -- Options for HTML output ---------------------------------------------------
1.98 +
1.99 +# The theme to use for HTML and HTML Help pages. See the documentation for
1.100 +# a list of builtin themes.
1.101 +html_theme = 'default'
1.102 +
1.103 +# Theme options are theme-specific and customize the look and feel of a theme
1.104 +# further. For a list of options available for each theme, see the
1.105 +# documentation.
1.106 +#html_theme_options = {}
1.107 +
1.108 +# Add any paths that contain custom themes here, relative to this directory.
1.109 +#html_theme_path = []
1.110 +
1.111 +# The name for this set of Sphinx documents. If None, it defaults to
1.112 +# "<project> v<release> documentation".
1.113 +#html_title = None
1.114 +
1.115 +# A shorter title for the navigation bar. Default is the same as html_title.
1.116 +#html_short_title = None
1.117 +
1.118 +# The name of an image file (relative to this directory) to place at the top
1.119 +# of the sidebar.
1.120 +#html_logo = None
1.121 +
1.122 +# The name of an image file (within the static path) to use as favicon of the
1.123 +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
1.124 +# pixels large.
1.125 +#html_favicon = None
1.126 +
1.127 +# Add any paths that contain custom static files (such as style sheets) here,
1.128 +# relative to this directory. They are copied after the builtin static files,
1.129 +# so a file named "default.css" will overwrite the builtin "default.css".
1.130 +html_static_path = ['_static']
1.131 +
1.132 +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
1.133 +# using the given strftime format.
1.134 +#html_last_updated_fmt = '%b %d, %Y'
1.135 +
1.136 +# If true, SmartyPants will be used to convert quotes and dashes to
1.137 +# typographically correct entities.
1.138 +#html_use_smartypants = True
1.139 +
1.140 +# Custom sidebar templates, maps document names to template names.
1.141 +#html_sidebars = {}
1.142 +
1.143 +# Additional templates that should be rendered to pages, maps page names to
1.144 +# template names.
1.145 +#html_additional_pages = {}
1.146 +
1.147 +# If false, no module index is generated.
1.148 +#html_domain_indices = True
1.149 +
1.150 +# If false, no index is generated.
1.151 +#html_use_index = True
1.152 +
1.153 +# If true, the index is split into individual pages for each letter.
1.154 +#html_split_index = False
1.155 +
1.156 +# If true, links to the reST sources are added to the pages.
1.157 +#html_show_sourcelink = True
1.158 +
1.159 +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
1.160 +#html_show_sphinx = True
1.161 +
1.162 +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
1.163 +#html_show_copyright = True
1.164 +
1.165 +# If true, an OpenSearch description file will be output, and all pages will
1.166 +# contain a <link> tag referring to it. The value of this option must be the
1.167 +# base URL from which the finished HTML is served.
1.168 +#html_use_opensearch = ''
1.169 +
1.170 +# This is the file name suffix for HTML files (e.g. ".xhtml").
1.171 +#html_file_suffix = None
1.172 +
1.173 +# Output file base name for HTML help builder.
1.174 +htmlhelp_basename = 'MarionettePythonClientdoc'
1.175 +
1.176 +
1.177 +# -- Options for LaTeX output --------------------------------------------------
1.178 +
1.179 +latex_elements = {
1.180 +# The paper size ('letterpaper' or 'a4paper').
1.181 +#'papersize': 'letterpaper',
1.182 +
1.183 +# The font size ('10pt', '11pt' or '12pt').
1.184 +#'pointsize': '10pt',
1.185 +
1.186 +# Additional stuff for the LaTeX preamble.
1.187 +#'preamble': '',
1.188 +}
1.189 +
1.190 +# Grouping the document tree into LaTeX files. List of tuples
1.191 +# (source start file, target name, title, author, documentclass [howto/manual]).
1.192 +latex_documents = [
1.193 + ('index', 'MarionettePythonClient.tex', u'Marionette Python Client Documentation',
1.194 + u'Mozilla Automation and Tools team', 'manual'),
1.195 +]
1.196 +
1.197 +# The name of an image file (relative to this directory) to place at the top of
1.198 +# the title page.
1.199 +#latex_logo = None
1.200 +
1.201 +# For "manual" documents, if this is true, then toplevel headings are parts,
1.202 +# not chapters.
1.203 +#latex_use_parts = False
1.204 +
1.205 +# If true, show page references after internal links.
1.206 +#latex_show_pagerefs = False
1.207 +
1.208 +# If true, show URL addresses after external links.
1.209 +#latex_show_urls = False
1.210 +
1.211 +# Documents to append as an appendix to all manuals.
1.212 +#latex_appendices = []
1.213 +
1.214 +# If false, no module index is generated.
1.215 +#latex_domain_indices = True
1.216 +
1.217 +
1.218 +# -- Options for manual page output --------------------------------------------
1.219 +
1.220 +# One entry per manual page. List of tuples
1.221 +# (source start file, name, description, authors, manual section).
1.222 +man_pages = [
1.223 + ('index', 'marionettepythonclient', u'Marionette Python Client Documentation',
1.224 + [u'Mozilla Automation and Tools team'], 1)
1.225 +]
1.226 +
1.227 +# If true, show URL addresses after external links.
1.228 +#man_show_urls = False
1.229 +
1.230 +
1.231 +# -- Options for Texinfo output ------------------------------------------------
1.232 +
1.233 +# Grouping the document tree into Texinfo files. List of tuples
1.234 +# (source start file, target name, title, author,
1.235 +# dir menu entry, description, category)
1.236 +texinfo_documents = [
1.237 + ('index', 'MarionettePythonClient', u'Marionette Python Client Documentation',
1.238 + u'Mozilla Automation and Tools team', 'MarionettePythonClient', 'One line description of project.',
1.239 + 'Miscellaneous'),
1.240 +]
1.241 +
1.242 +# Documents to append as an appendix to all manuals.
1.243 +#texinfo_appendices = []
1.244 +
1.245 +# If false, no module index is generated.
1.246 +#texinfo_domain_indices = True
1.247 +
1.248 +# How to display URL addresses: 'footnote', 'no', or 'inline'.
1.249 +#texinfo_show_urls = 'footnote'
