source: trunk/adm/website/conf.py @ 204

# -*- coding: iso-latin-1 -*-
#
# DESCRIPTION
# ===========
#
# tropflux documentation build configuration file, created by
# sphinx-quickstart on Wed Mar 30 14:42:18 2011.
#
# TODO
# ====
#
# - fplod 20120229
#
#   * exclude README.rst see :`updatedata`
#
# - fplod 20110407T092856Z aedon.locean-ipsl.upmc.fr (Darwin)
#
#   * improve latex document (ugly now !)
#
# - fplod 20110330T142745Z aedon.locean-ipsl.upmc.fr (Darwin)
#
#   * add path for matplotlib extension of sphinx f(python installation)
#
# EVOLUTIONS
# ==========
#
# $Id$
#
# $URL$
#
# - fplod 20130716T112452Z cratos.locean-ipsl.upmc.fr (Linux)
#
#   * remove inheritance_diagram not needed here and trouble with Sphinx 1.2b1
#
# - fplod 20120223
#
#   * fix syntax error for exclude prolog.rst
#
# - fplod 20120222
#
#   * typo for exclusion of prolog.rst
#   * change PDF and HTML title (no more version)
#   * add rst_prolog
#     thanks to https://github.com/leaflabs/leaflabs-docs/blob/master/source/conf.py
#
# - fplod 20120221
#
#   * add authors
#     thanks to http://www.fileformat.info/info/unicode/char/search.htm
#     for utf encoding
#
# - fplod 20120220
#
#   * remove index generation (so no more index in the sidebar of HTML pages)
#
# - fplod 20120219
#
#   * chgt release
#
# - fplod 20110623T164817Z aedon.locean-ipsl.upmc.fr (Darwin)
#
#   * chgt release
#
# - fplod 20110622T135106Z aedon.locean-ipsl.upmc.fr (Darwin)
#
#   * remove source link
#
# - fplod 20110330T124501Z aedon.locean-ipsl.upmc.fr (Darwin)
#
#   * sphinx-quickstart 1.0.7
#   * see http://matplotlib.sourceforge.net/sampledoc/
#
# This file is execfile()d with the current directory set to its containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.

import sys, os

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#sys.path.insert(0, os.path.abspath('.'))
sys.path.append(os.path.abspath('sphinxext'))
#
# -- General configuration -----------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'

# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.autodoc',
              'sphinx.ext.doctest',
              'sphinx.ext.intersphinx',
              'sphinx.ext.todo',
              'sphinx.ext.coverage',
              'sphinx.ext.pngmath',
              'sphinx.ext.ifconfig',
              'sphinx.ext.viewcode',
          'ipython_console_highlighting',
          'numpydoc']

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# The suffix of source filenames.
source_suffix = '.rst'

# The encoding of source files.
source_encoding = 'iso-8859-15'

# The master toctree document.
master_doc = 'index'

# General information about the project.
project = u'TropFlux'
copyright = u'2011, IRD'

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '0.1.0'
# The full version, including alpha/beta/rc tags.
release = '1.0.0'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None

# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build', 'prolog.rst', 'README.rst']

# Included at the beginning of every source file that is read.
with open('prolog.rst', 'r') as pr:
    rst_prolog = pr.read()

# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None

# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True

# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True

# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'

# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []


# -- Options for HTML output ---------------------------------------------------

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
html_theme = 'sphinxdoc'

# Theme options are theme-specific and customize the look and feel of a theme
# further.  For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}

# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []

# The name for this set of Sphinx documents.  If None, it defaults to
# "<project> v<release> documentation".
html_title = project + ' : air-sea fluxes for the global tropical oceans'

# A shorter title for the navigation bar.  Default is the same as html_title.
html_short_title = project

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
html_logo = None

# The name of an image file (within the static path) to use as favicon of the
# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
html_favicon = None

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'

# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True

# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}

# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {'index': 'index.html'}

# If false, no module index is generated.
#html_domain_indices = True

# If false, no index is generated.
html_use_index = False

# If true, the index is split into individual pages for each letter.
#html_split_index = False

# If true, links to the reST sources are added to the pages.
html_show_sourcelink = False

# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True

# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
html_show_copyright = False

# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it.  The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''

# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None

# Output file base name for HTML help builder.
htmlhelp_basename = 'tropfluxdoc'


# -- Options for LaTeX output --------------------------------------------------

# The paper size ('letter' or 'a4').
latex_paper_size = 'a4'

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

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('index', 'tropflux.tex', u'TropFlux : air-sea fluxes for the global tropical oceans', u'J\u00E9r\u00F4me Vialard, B. Praveen Kumar, Fran\u00E7oise Pinsard', 'howto'),
]

# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None

# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False

# If true, show page references after internal links.
latex_show_pagerefs = True

# If true, show URL addresses after external links.
latex_show_urls = True

# Additional stuff for the LaTeX preamble.
#latex_preamble = ''

# Documents to append as an appendix to all manuals.
#latex_appendices = []

# If false, no module index is generated.
#latex_domain_indices = True

# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'http://docs.python.org/': None}