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