testing/mozbase/docs/conf.py

Wed, 31 Dec 2014 06:09:35 +0100

author
Michael Schloh von Bennewitz <michael@schloh.com>
date
Wed, 31 Dec 2014 06:09:35 +0100
changeset 0
6474c204b198
permissions
-rw-r--r--

Cloned upstream origin tor-browser at tor-browser-31.3.0esr-4.5-1-build1
revision ID fc1c9ff7c1b2defdbc039f12214767608f46423f for hacking purpose.

     1 # -*- coding: utf-8 -*-
     2 #
     3 # MozBase documentation build configuration file, created by
     4 # sphinx-quickstart on Mon Oct 22 14:02:17 2012.
     5 #
     6 # This file is execfile()d with the current directory set to its containing dir.
     7 #
     8 # Note that not all possible configuration values are present in this
     9 # autogenerated file.
    10 #
    11 # All configuration values have a default; values that are commented out
    12 # serve to show the default.
    14 import sys, os
    16 # If extensions (or modules to document with autodoc) are in another directory,
    17 # add these directories to sys.path here. If the directory is relative to the
    18 # documentation root, use os.path.abspath to make it absolute, like shown here.
    19 here = os.path.dirname(os.path.abspath(__file__))
    20 parent = os.path.dirname(here)
    21 for item in os.listdir(parent):
    22     path = os.path.join(parent, item)
    23     if (not os.path.isdir(path)) or (not os.path.exists(os.path.join(path, 'setup.py'))):
    24         continue
    25     sys.path.insert(0, path)
    27 # -- General configuration -----------------------------------------------------
    29 # If your documentation needs a minimal Sphinx version, state it here.
    30 #needs_sphinx = '1.0'
    32 # Add any Sphinx extension module names here, as strings. They can be extensions
    33 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
    34 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.todo', 'sphinx.ext.viewcode']
    36 # Add any paths that contain templates here, relative to this directory.
    37 templates_path = ['_templates']
    39 # The suffix of source filenames.
    40 source_suffix = '.rst'
    42 # The encoding of source files.
    43 #source_encoding = 'utf-8-sig'
    45 # The master toctree document.
    46 master_doc = 'index'
    48 # General information about the project.
    49 project = u'MozBase'
    50 copyright = u'2012, Mozilla Automation and Tools team'
    52 # The version info for the project you're documenting, acts as replacement for
    53 # |version| and |release|, also used in various other places throughout the
    54 # built documents.
    55 #
    56 # The short X.Y version.
    57 version = '1'
    58 # The full version, including alpha/beta/rc tags.
    59 release = '1'
    61 # The language for content autogenerated by Sphinx. Refer to documentation
    62 # for a list of supported languages.
    63 #language = None
    65 # There are two options for replacing |today|: either, you set today to some
    66 # non-false value, then it is used:
    67 #today = ''
    68 # Else, today_fmt is used as the format for a strftime call.
    69 #today_fmt = '%B %d, %Y'
    71 # List of patterns, relative to source directory, that match files and
    72 # directories to ignore when looking for source files.
    73 exclude_patterns = ['_build']
    75 # The reST default role (used for this markup: `text`) to use for all documents.
    76 #default_role = None
    78 # If true, '()' will be appended to :func: etc. cross-reference text.
    79 #add_function_parentheses = True
    81 # If true, the current module name will be prepended to all description
    82 # unit titles (such as .. function::).
    83 #add_module_names = True
    85 # If true, sectionauthor and moduleauthor directives will be shown in the
    86 # output. They are ignored by default.
    87 #show_authors = False
    89 # The name of the Pygments (syntax highlighting) style to use.
    90 pygments_style = 'sphinx'
    92 # A list of ignored prefixes for module index sorting.
    93 #modindex_common_prefix = []
    96 # -- Options for HTML output ---------------------------------------------------
    98 # The theme to use for HTML and HTML Help pages.  See the documentation for
    99 # a list of builtin themes.
   100 html_theme = 'default'
   102 # Theme options are theme-specific and customize the look and feel of a theme
   103 # further.  For a list of options available for each theme, see the
   104 # documentation.
   105 #html_theme_options = {}
   107 # Add any paths that contain custom themes here, relative to this directory.
   108 #html_theme_path = []
   110 # The name for this set of Sphinx documents.  If None, it defaults to
   111 # "<project> v<release> documentation".
   112 html_title = "mozbase documentation"
   114 # A shorter title for the navigation bar.  Default is the same as html_title.
   115 #html_short_title = None
   117 # The name of an image file (relative to this directory) to place at the top
   118 # of the sidebar.
   119 #html_logo = None
   121 # The name of an image file (within the static path) to use as favicon of the
   122 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
   123 # pixels large.
   124 #html_favicon = None
   126 # Add any paths that contain custom static files (such as style sheets) here,
   127 # relative to this directory. They are copied after the builtin static files,
   128 # so a file named "default.css" will overwrite the builtin "default.css".
   129 html_static_path = ['_static']
   131 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
   132 # using the given strftime format.
   133 #html_last_updated_fmt = '%b %d, %Y'
   135 # If true, SmartyPants will be used to convert quotes and dashes to
   136 # typographically correct entities.
   137 #html_use_smartypants = True
   139 # Custom sidebar templates, maps document names to template names.
   140 #html_sidebars = {}
   142 # Additional templates that should be rendered to pages, maps page names to
   143 # template names.
   144 #html_additional_pages = {}
   146 # If false, no module index is generated.
   147 #html_domain_indices = True
   149 # If false, no index is generated.
   150 #html_use_index = True
   152 # If true, the index is split into individual pages for each letter.
   153 #html_split_index = False
   155 # If true, links to the reST sources are added to the pages.
   156 #html_show_sourcelink = True
   158 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
   159 #html_show_sphinx = True
   161 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
   162 #html_show_copyright = True
   164 # If true, an OpenSearch description file will be output, and all pages will
   165 # contain a <link> tag referring to it.  The value of this option must be the
   166 # base URL from which the finished HTML is served.
   167 #html_use_opensearch = ''
   169 # This is the file name suffix for HTML files (e.g. ".xhtml").
   170 #html_file_suffix = None
   172 # Output file base name for HTML help builder.
   173 htmlhelp_basename = 'MozBasedoc'
   176 # -- Options for LaTeX output --------------------------------------------------
   178 latex_elements = {
   179 # The paper size ('letterpaper' or 'a4paper').
   180 #'papersize': 'letterpaper',
   182 # The font size ('10pt', '11pt' or '12pt').
   183 #'pointsize': '10pt',
   185 # Additional stuff for the LaTeX preamble.
   186 #'preamble': '',
   187 }
   189 # Grouping the document tree into LaTeX files. List of tuples
   190 # (source start file, target name, title, author, documentclass [howto/manual]).
   191 latex_documents = [
   192   ('index', 'MozBase.tex', u'MozBase Documentation',
   193    u'Mozilla Automation and Tools team', 'manual'),
   194 ]
   196 # The name of an image file (relative to this directory) to place at the top of
   197 # the title page.
   198 #latex_logo = None
   200 # For "manual" documents, if this is true, then toplevel headings are parts,
   201 # not chapters.
   202 #latex_use_parts = False
   204 # If true, show page references after internal links.
   205 #latex_show_pagerefs = False
   207 # If true, show URL addresses after external links.
   208 #latex_show_urls = False
   210 # Documents to append as an appendix to all manuals.
   211 #latex_appendices = []
   213 # If false, no module index is generated.
   214 #latex_domain_indices = True
   217 # -- Options for manual page output --------------------------------------------
   219 # One entry per manual page. List of tuples
   220 # (source start file, name, description, authors, manual section).
   221 man_pages = [
   222     ('index', 'mozbase', u'MozBase Documentation',
   223      [u'Mozilla Automation and Tools team'], 1)
   224 ]
   226 # If true, show URL addresses after external links.
   227 #man_show_urls = False
   230 # -- Options for Texinfo output ------------------------------------------------
   232 # Grouping the document tree into Texinfo files. List of tuples
   233 # (source start file, target name, title, author,
   234 #  dir menu entry, description, category)
   235 texinfo_documents = [
   236   ('index', 'MozBase', u'MozBase Documentation',
   237    u'Mozilla Automation and Tools team', 'MozBase', 'One line description of project.',
   238    'Miscellaneous'),
   239 ]
   241 # Documents to append as an appendix to all manuals.
   242 #texinfo_appendices = []
   244 # If false, no module index is generated.
   245 #texinfo_domain_indices = True
   247 # How to display URL addresses: 'footnote', 'no', or 'inline'.
   248 #texinfo_show_urls = 'footnote'

mercurial