buildframework/helium/doc/src_search/conf.py
author wbernard
Tue, 27 Apr 2010 08:33:08 +0300
changeset 587 85df38eb4012
permissions -rw-r--r--
helium_9.0-a7879c935424
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     1
# -*- coding: utf-8 -*-
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     2
#============================================================================ 
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     3
#Name        : ant.py 
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     4
#Part of     : Helium 
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     5
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     6
#Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     7
#All rights reserved.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     8
#This component and the accompanying materials are made available
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     9
#under the terms of the License "Eclipse Public License v1.0"
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    10
#which accompanies this distribution, and is available
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    11
#at the URL "http://www.eclipse.org/legal/epl-v10.html".
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    12
#
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    13
#Initial Contributors:
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    14
#Nokia Corporation - initial contribution.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    15
#
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    16
#Contributors:
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    17
#
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    18
#Description:
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    19
#===============================================================================
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    20
#
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    21
# Helium Documentation documentation build configuration file, created by
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    22
# sphinx-quickstart on Fri May 09 09:49:44 2008.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    23
#
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    24
# This file is execfile()d with the current directory set to its containing dir.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    25
#
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    26
# The contents of this file are pickled, so don't put values in the namespace
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    27
# that aren't pickleable (module imports are okay, they're removed automatically).
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    28
#
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    29
# All configuration values have a default value; values that are commented out
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    30
# serve to show the default value.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    31
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    32
import sys, os
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    33
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    34
# If your extensions are in another directory, add it here. If the directory
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    35
# is relative to the documentation root, use os.path.abspath to make it
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    36
# absolute, like shown here.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    37
#sys.path.append(os.path.abspath('some/directory'))
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    38
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    39
# General configuration
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    40
# ---------------------
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    41
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    42
# Add any Sphinx extension module names here, as strings. They can be extensions
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    43
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    44
#extensions = []
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    45
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    46
# Add any paths that contain templates here, relative to this directory.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    47
templates_path = ['.templates']
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    48
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    49
# The suffix of source filenames.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    50
source_suffix = '.rst'
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    51
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    52
# The master toctree document.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    53
master_doc = 'index'
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    54
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    55
# General substitutions.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    56
project = 'Helium'
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    57
copyright = '2009 Nokia Corporation and/or its subsidiary(-ies). All rights reserved. License: http://www.eclipse.org/legal/epl-v10.html'
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    58
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    59
# The default replacements for |version| and |release|, also used in various
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    60
# other places throughout the built documents.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    61
#
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    62
# The short X.Y version.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    63
version = '0.23'
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    64
# The full version, including alpha/beta/rc tags.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    65
release = '0.23'
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    66
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    67
# There are two options for replacing |today|: either, you set today to some
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    68
# non-false value, then it is used:
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    69
#today = ''
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    70
# Else, today_fmt is used as the format for a strftime call.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    71
today_fmt = '%B %d, %Y'
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    72
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    73
# List of documents that shouldn't be included in the build.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    74
#unused_docs = []
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    75
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    76
# List of directories, relative to source directories, that shouldn't be searched
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    77
# for source files.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    78
#exclude_dirs = []
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    79
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    80
# If true, '()' will be appended to :func: etc. cross-reference text.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    81
#add_function_parentheses = True
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    82
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    83
# If true, the current module name will be prepended to all description
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    84
# unit titles (such as .. function::).
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    85
#add_module_names = True
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    86
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    87
# If true, sectionauthor and moduleauthor directives will be shown in the
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    88
# output. They are ignored by default.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    89
#show_authors = False
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    90
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    91
# The name of the Pygments (syntax highlighting) style to use.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    92
pygments_style = 'sphinx'
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    93
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    94
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    95
# Options for HTML output
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    96
# -----------------------
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    97
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    98
# The style sheet to use for HTML and HTML Help pages. A file of that name
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    99
# must exist either in Sphinx' static/ path, or in one of the custom paths
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   100
# given in html_static_path.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   101
html_style = 'default.css'
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   102
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   103
# The name for this set of Sphinx documents.  If None, it defaults to
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   104
# "<project> v<release> documentation".
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   105
#html_title = None
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   106
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   107
# The name of an image file (within the static path) to place at the top of
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   108
# the sidebar.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   109
html_logo = 'helium_pallot_small.jpg'
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   110
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   111
# Add any paths that contain custom static files (such as style sheets) here,
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   112
# relative to this directory. They are copied after the builtin static files,
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   113
# so a file named "default.css" will overwrite the builtin "default.css".
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   114
html_static_path = ['.static']
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   115
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   116
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   117
# using the given strftime format.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   118
html_last_updated_fmt = '%b %d, %Y'
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   119
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   120
# If true, SmartyPants will be used to convert quotes and dashes to
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   121
# typographically correct entities.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   122
#html_use_smartypants = True
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   123
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   124
# Custom sidebar templates, maps document names to template names.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   125
#html_sidebars = {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   126
#}
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   127
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   128
# Additional templates that should be rendered to pages, maps page names to
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   129
# template names.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   130
#html_additional_pages = {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   131
#}
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   132
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   133
# If false, no module index is generated.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   134
html_use_modindex = False
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   135
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   136
# If true, the reST sources are included in the HTML build as _sources/<name>.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   137
#html_copy_source = True
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   138
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   139
# If true, an OpenSearch description file will be output, and all pages will
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   140
# contain a <link> tag referring to it.  The value of this option must be the
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   141
# base URL from which the finished HTML is served.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   142
#html_use_opensearch = ''
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   143
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   144
# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   145
#html_file_suffix = ''
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   146
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   147
# Output file base name for HTML help builder.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   148
htmlhelp_basename = 'Helium doc'
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   149
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   150
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   151
# Options for LaTeX output
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   152
# ------------------------
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   153
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   154
# The paper size ('letter' or 'a4').
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   155
#latex_paper_size = 'letter'
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   156
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   157
# The font size ('10pt', '11pt' or '12pt').
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   158
#latex_font_size = '10pt'
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   159
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   160
# Grouping the document tree into LaTeX files. List of tuples
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   161
# (source start file, target name, title, author, document class [howto/manual]).
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   162
latex_documents = [
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   163
  ('index', 'Helium.tex', 'Helium Documentation', 'The Helium Team', 'manual'),
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   164
]
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   165
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   166
# The name of an image file (relative to this directory) to place at the top of
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   167
# the title page.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   168
#latex_logo = None
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   169
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   170
# For "manual" documents, if this is true, then toplevel headings are parts,
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   171
# not chapters.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   172
#latex_use_parts = False
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   173
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   174
# Additional stuff for the LaTeX preamble.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   175
#latex_preamble = ''
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   176
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   177
# Documents to append as an appendix to all manuals.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   178
#latex_appendices = []
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   179
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   180
# If false, no module index is generated.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   181
#latex_use_modindex = True