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

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

add data files in website

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