1 # -*- coding: utf-8 -*-

     2 #============================================================================ 

     3 #Name        : ant.py 

     4 #Part of     : Helium 

     5 

     6 #Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).

     7 #All rights reserved.

     8 #This component and the accompanying materials are made available

     9 #under the terms of the License "Eclipse Public License v1.0"

    10 #which accompanies this distribution, and is available

    11 #at the URL "http://www.eclipse.org/legal/epl-v10.html".

    12 #

    13 #Initial Contributors:

    14 #Nokia Corporation - initial contribution.

    15 #

    16 #Contributors:

    17 #

    18 #Description:

    19 #===============================================================================

    20 #

    21 # Helium Documentation documentation build configuration file, created by

    22 # sphinx-quickstart on Fri May 09 09:49:44 2008.

    23 #

    24 # This file is execfile()d with the current directory set to its containing dir.

    25 #

    26 # The contents of this file are pickled, so don't put values in the namespace

    27 # that aren't pickleable (module imports are okay, they're removed automatically).

    28 #

    29 # All configuration values have a default value; values that are commented out

    30 # serve to show the default value.

    31 

    32 import sys, os

    33 

    34 # If your extensions are in another directory, add it here. If the directory

    35 # is relative to the documentation root, use os.path.abspath to make it

    36 # absolute, like shown here.

    37 #sys.path.append(os.path.abspath('some/directory'))

    38 

    39 # General configuration

    40 # ---------------------

    41 

    42 # Add any Sphinx extension module names here, as strings. They can be extensions

    43 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.

    44 extensions = ['sphinx_ext']

    45 

    46 # Add any paths that contain templates here, relative to this directory.

    47 templates_path = ['.templates']

    48 

    49 # The suffix of source filenames.

    50 source_suffix = '.rst'

    51 

    52 # The master toctree document.

    53 master_doc = 'index'

    54 

    55 # General substitutions.

    56 project = 'Helium'

    57 copyright = '2009 Nokia Corporation and/or its subsidiary(-ies). All rights reserved. License: http://www.eclipse.org/legal/epl-v10.html'

    58 

    59 # The default replacements for |version| and |release|, also used in various

    60 # other places throughout the built documents.

    61 #

    62 # The short X.Y version.

    63 version = '0.23'

    64 # The full version, including alpha/beta/rc tags.

    65 release = '0.23'

    66 

    67 # There are two options for replacing |today|: either, you set today to some

    68 # non-false value, then it is used:

    69 #today = ''

    70 # Else, today_fmt is used as the format for a strftime call.

    71 today_fmt = '%B %d, %Y'

    72 

    73 # List of documents that shouldn't be included in the build.

    74 #unused_docs = []

    75 

    76 # List of directories, relative to source directories, that shouldn't be searched

    77 # for source files.

    78 #exclude_dirs = []

    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 

    95 # Options for HTML output

    96 # -----------------------

    97 

    98 # The style sheet to use for HTML and HTML Help pages. A file of that name

    99 # must exist either in Sphinx' static/ path, or in one of the custom paths

   100 # given in html_static_path.

   101 html_style = 'default.css'

   102 

   103 # The name for this set of Sphinx documents.  If None, it defaults to

   104 # "<project> v<release> documentation".

   105 #html_title = None

   106 

   107 # The name of an image file (within the static path) to place at the top of

   108 # the sidebar.

   109 html_logo = 'helium_pallot_small.jpg'

   110 

   111 # Add any paths that contain custom static files (such as style sheets) here,

   112 # relative to this directory. They are copied after the builtin static files,

   113 # so a file named "default.css" will overwrite the builtin "default.css".

   114 html_static_path = ['.static']

   115 

   116 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,

   117 # using the given strftime format.

   118 html_last_updated_fmt = '%b %d, %Y'

   119 

   120 # If true, SmartyPants will be used to convert quotes and dashes to

   121 # typographically correct entities.

   122 #html_use_smartypants = True

   123 

   124 # Custom sidebar templates, maps document names to template names.

   125 html_sidebars = {

   126    'index': 'sidebar.html'

   127 }

   128 

   129 # Additional templates that should be rendered to pages, maps page names to

   130 # template names.

   131 #html_additional_pages = {

   132 #}

   133 

   134 # If false, no module index is generated.

   135 html_use_modindex = False

   136 

   137 # If true, the reST sources are included in the HTML build as _sources/<name>.

   138 #html_copy_source = True

   139 

   140 # If true, an OpenSearch description file will be output, and all pages will

   141 # contain a <link> tag referring to it.  The value of this option must be the

   142 # base URL from which the finished HTML is served.

   143 #html_use_opensearch = ''

   144 

   145 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").

   146 #html_file_suffix = ''

   147 

   148 # Output file base name for HTML help builder.

   149 htmlhelp_basename = 'Helium doc'

   150 

   151 

   152 # Options for LaTeX output

   153 # ------------------------

   154 

   155 # The paper size ('letter' or 'a4').

   156 #latex_paper_size = 'letter'

   157 

   158 # The font size ('10pt', '11pt' or '12pt').

   159 #latex_font_size = '10pt'

   160 

   161 # Grouping the document tree into LaTeX files. List of tuples

   162 # (source start file, target name, title, author, document class [howto/manual]).

   163 latex_documents = [

   164   ('index', 'Helium.tex', 'Helium Documentation', 'The Helium Team', 'manual'),

   165 ]

   166 

   167 # The name of an image file (relative to this directory) to place at the top of

   168 # the title page.

   169 #latex_logo = None

   170 

   171 # For "manual" documents, if this is true, then toplevel headings are parts,

   172 # not chapters.

   173 #latex_use_parts = False

   174 

   175 # Additional stuff for the LaTeX preamble.

   176 #latex_preamble = ''

   177 

   178 # Documents to append as an appendix to all manuals.

   179 #latex_appendices = []

   180 

   181 # If false, no module index is generated.

   182 #latex_use_modindex = True