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

Last change on this file since 53 was 53, checked in by pinsard, 11 years ago

fill website pages

File size: 8.0 KB
Line 
1# -*- coding: iso-latin-1 -*-
2#
3# tropflux documentation build configuration file, created by
4# sphinx-quickstart on Wed Mar 30 14:42:18 2011.
5#
6#
7# TODO
8# ====
9#
10# - fplod 20110407T092856Z aedon.locean-ipsl.upmc.fr (Darwin)
11#
12#   * improve latex document (ugly now !)
13#
14# - fplod 20110330T142745Z aedon.locean-ipsl.upmc.fr (Darwin)
15#
16#   * add path for matploblib extension of sphinx f(python installation)
17#
18# EVOLUTIONS
19# ==========
20#
21# $Id$
22#
23# $URL$
24#
25# - fplod 20110623T164817Z aedon.locean-ipsl.upmc.fr (Darwin)
26#
27#   * chgt release
28# - fplod 20110622T135106Z aedon.locean-ipsl.upmc.fr (Darwin)
29#
30#   * remove source link
31#
32# - fplod 20110330T124501Z aedon.locean-ipsl.upmc.fr (Darwin)
33#
34#   * sphinx-quickstart 1.0.7
35#   * see http://matplotlib.sourceforge.net/sampledoc/
36#
37# This file is execfile()d with the current directory set to its containing dir.
38#
39# Note that not all possible configuration values are present in this
40# autogenerated file.
41#
42# All configuration values have a default; values that are commented out
43# serve to show the default.
44
45import sys, os
46
47# If extensions (or modules to document with autodoc) are in another directory,
48# add these directories to sys.path here. If the directory is relative to the
49# documentation root, use os.path.abspath to make it absolute, like shown here.
50#sys.path.insert(0, os.path.abspath('.'))
51sys.path.append(os.path.abspath('sphinxext'))
52#
53# -- General configuration -----------------------------------------------------
54
55# If your documentation needs a minimal Sphinx version, state it here.
56#needs_sphinx = '1.0'
57
58# Add any Sphinx extension module names here, as strings. They can be extensions
59# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
60extensions = ['sphinx.ext.autodoc',
61              'sphinx.ext.doctest',
62              'sphinx.ext.intersphinx',
63              'sphinx.ext.todo',
64              'sphinx.ext.coverage',
65              'sphinx.ext.pngmath',
66              'sphinx.ext.ifconfig',
67              'sphinx.ext.viewcode',
68          'ipython_console_highlighting',
69          'inheritance_diagram',
70          'numpydoc']
71
72# Add any paths that contain templates here, relative to this directory.
73templates_path = ['_templates']
74
75# The suffix of source filenames.
76source_suffix = '.rst'
77
78# The encoding of source files.
79source_encoding = 'iso-8859-15'
80
81# The master toctree document.
82master_doc = 'contents'
83
84# General information about the project.
85project = u'TROPFLUX'
86copyright = u'2011, IRD'
87
88# The version info for the project you're documenting, acts as replacement for
89# |version| and |release|, also used in various other places throughout the
90# built documents.
91#
92# The short X.Y version.
93version = '0.1.0'
94# The full version, including alpha/beta/rc tags.
95release = '0.1.0'
96
97# The language for content autogenerated by Sphinx. Refer to documentation
98# for a list of supported languages.
99#language = None
100
101# There are two options for replacing |today|: either, you set today to some
102# non-false value, then it is used:
103#today = ''
104# Else, today_fmt is used as the format for a strftime call.
105#today_fmt = '%B %d, %Y'
106
107# List of patterns, relative to source directory, that match files and
108# directories to ignore when looking for source files.
109exclude_patterns = ['_build']
110
111# The reST default role (used for this markup: `text`) to use for all documents.
112#default_role = None
113
114# If true, '()' will be appended to :func: etc. cross-reference text.
115#add_function_parentheses = True
116
117# If true, the current module name will be prepended to all description
118# unit titles (such as .. function::).
119#add_module_names = True
120
121# If true, sectionauthor and moduleauthor directives will be shown in the
122# output. They are ignored by default.
123#show_authors = False
124
125# The name of the Pygments (syntax highlighting) style to use.
126pygments_style = 'sphinx'
127
128# A list of ignored prefixes for module index sorting.
129#modindex_common_prefix = []
130
131
132# -- Options for HTML output ---------------------------------------------------
133
134# The theme to use for HTML and HTML Help pages.  See the documentation for
135# a list of builtin themes.
136html_theme = 'sphinxdoc'
137
138# Theme options are theme-specific and customize the look and feel of a theme
139# further.  For a list of options available for each theme, see the
140# documentation.
141#html_theme_options = {}
142
143# Add any paths that contain custom themes here, relative to this directory.
144#html_theme_path = []
145
146# The name for this set of Sphinx documents.  If None, it defaults to
147# "<project> v<release> documentation".
148#html_title = None
149
150# A shorter title for the navigation bar.  Default is the same as html_title.
151#html_short_title = None
152
153# The name of an image file (relative to this directory) to place at the top
154# of the sidebar.
155html_logo = None
156
157# The name of an image file (within the static path) to use as favicon of the
158# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
159# pixels large.
160html_favicon = None
161
162# Add any paths that contain custom static files (such as style sheets) here,
163# relative to this directory. They are copied after the builtin static files,
164# so a file named "default.css" will overwrite the builtin "default.css".
165html_static_path = ['_static']
166
167# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
168# using the given strftime format.
169#html_last_updated_fmt = '%b %d, %Y'
170
171# If true, SmartyPants will be used to convert quotes and dashes to
172# typographically correct entities.
173#html_use_smartypants = True
174
175# Custom sidebar templates, maps document names to template names.
176#html_sidebars = {}
177
178# Additional templates that should be rendered to pages, maps page names to
179# template names.
180html_additional_pages = {'index': 'index.html'}
181
182# If false, no module index is generated.
183#html_domain_indices = True
184
185# If false, no index is generated.
186#html_use_index = True
187
188# If true, the index is split into individual pages for each letter.
189#html_split_index = False
190
191# If true, links to the reST sources are added to the pages.
192html_show_sourcelink = False
193
194# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
195#html_show_sphinx = True
196
197# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
198#html_show_copyright = True
199
200# If true, an OpenSearch description file will be output, and all pages will
201# contain a <link> tag referring to it.  The value of this option must be the
202# base URL from which the finished HTML is served.
203#html_use_opensearch = ''
204
205# This is the file name suffix for HTML files (e.g. ".xhtml").
206#html_file_suffix = None
207
208# Output file base name for HTML help builder.
209htmlhelp_basename = 'tropfluxdoc'
210
211
212# -- Options for LaTeX output --------------------------------------------------
213
214# The paper size ('letter' or 'a4').
215#latex_paper_size = 'letter'
216
217# The font size ('10pt', '11pt' or '12pt').
218#latex_font_size = '10pt'
219
220# Grouping the document tree into LaTeX files. List of tuples
221# (source start file, target name, title, author, documentclass [howto/manual]).
222latex_documents = [
223  ('contents', 'tropflux.tex', u'TropFlux Documentation', u'J\u00E9r\u00F4me Vialard ', 'howto'),
224]
225
226# The name of an image file (relative to this directory) to place at the top of
227# the title page.
228#latex_logo = None
229
230# For "manual" documents, if this is true, then toplevel headings are parts,
231# not chapters.
232#latex_use_parts = False
233
234# If true, show page references after internal links.
235#latex_show_pagerefs = False
236
237# If true, show URL addresses after external links.
238#latex_show_urls = False
239
240# Additional stuff for the LaTeX preamble.
241#latex_preamble = ''
242
243# Documents to append as an appendix to all manuals.
244#latex_appendices = []
245
246# If false, no module index is generated.
247#latex_domain_indices = True
248
249
250# -- Options for manual page output --------------------------------------------
251
252# One entry per manual page. List of tuples
253# (source start file, name, description, authors, manual section).
254man_pages = [
255    ('index', 'tropflux', u'TropFlux Documentation',
256     [u'J\u00E9r\u00F4me Vialard'], 1)
257]
258
259
260# Example configuration for intersphinx: refer to the Python standard library.
261intersphinx_mapping = {'http://docs.python.org/': None}
Note: See TracBrowser for help on using the repository browser.