1 | # -*- coding: utf-8 -*- |
---|
2 | # |
---|
3 | # TROPFLUX documentation build configuration file, created by |
---|
4 | # sphinx-quickstart on Thu Nov 18 17:59:16 2010. |
---|
5 | # |
---|
6 | # This file is execfile()d with the current directory set to its containing dir. |
---|
7 | # |
---|
8 | # Note that not all possible configuration values are present in this |
---|
9 | # autogenerated file. |
---|
10 | # |
---|
11 | # All configuration values have a default; values that are commented out |
---|
12 | # serve to show the default. |
---|
13 | # |
---|
14 | # TODO |
---|
15 | # ==== |
---|
16 | # |
---|
17 | # suppression de la toc dans README.pdf |
---|
18 | # |
---|
19 | # nb documentclass report pas possible car le report.cls n'est pas disponible |
---|
20 | # |
---|
21 | # automatisation of manual pages list |
---|
22 | # |
---|
23 | # intersphinx_mapping with saxo |
---|
24 | # |
---|
25 | # make autodoc work for test/read.py |
---|
26 | # |
---|
27 | # EVOLUTIONS |
---|
28 | # ========== |
---|
29 | # |
---|
30 | # - fplod 20110622T074544Z cratos.locean-ipsl.upmc.fr (Linux) |
---|
31 | # |
---|
32 | # * graphviz attributes (cf. http://sphinx.pocoo.org/ext/inheritance.html#confval-inheritance_graph_attrs) |
---|
33 | # |
---|
34 | # - fplod 20110203T101316Z aedon.locean-ipsl.upmc.fr (Darwin) |
---|
35 | # |
---|
36 | # * intersphinx with cdo |
---|
37 | # |
---|
38 | # - fplod 20110106T151836Z aedon.locean-ipsl.upmc.fr (Darwin) |
---|
39 | # |
---|
40 | # * add autodoc extension |
---|
41 | # |
---|
42 | # - fplod 20101223T083524Z aedon.locean-ipsl.upmc.fr (Darwin) |
---|
43 | # |
---|
44 | # * intersphinx with nco |
---|
45 | # |
---|
46 | # - fplod 20101220T092450Z aedon.locean-ipsl.upmc.fr (Darwin) |
---|
47 | # |
---|
48 | # * intersphinx with saxo |
---|
49 | # cf. http://sphinx.pocoo.org/ext/intersphinx.html |
---|
50 | # |
---|
51 | # - fplod 20101216T155711Z aedon.locean-ipsl.upmc.fr (Darwin) |
---|
52 | # |
---|
53 | # * add new hard coded manual pages |
---|
54 | # |
---|
55 | # - fplod 20101214T110437Z aedon.locean-ipsl.upmc.fr (Darwin) |
---|
56 | # |
---|
57 | # * add graphviz extension |
---|
58 | # |
---|
59 | # - fplod 20101213T163131Z aedon.locean-ipsl.upmc.fr (Darwin) |
---|
60 | # |
---|
61 | # * add hard coded manual pages (get_*.sh) |
---|
62 | # |
---|
63 | # - fplod 20101213T150221Z aedon.locean-ipsl.upmc.fr (Darwin) |
---|
64 | # |
---|
65 | # * add hard coded manual pages |
---|
66 | # |
---|
67 | # - fplod 20101209T092121Z aedon.locean-ipsl.upmc.fr (Darwin) |
---|
68 | # |
---|
69 | # * add creation of README.pdf |
---|
70 | # |
---|
71 | # - fplod 20101125T085318Z aedon.locean-ipsl.upmc.fr (Darwin) |
---|
72 | # |
---|
73 | # * modify extensions |
---|
74 | # |
---|
75 | #- |
---|
76 | |
---|
77 | import sys, os |
---|
78 | |
---|
79 | # If extensions (or modules to document with autodoc) are in another directory, |
---|
80 | # add these directories to sys.path here. If the directory is relative to the |
---|
81 | # documentation root, use os.path.abspath to make it absolute, like shown here. |
---|
82 | #sys.path.insert(0, os.path.abspath('.')) |
---|
83 | |
---|
84 | # -- General configuration ----------------------------------------------------- |
---|
85 | |
---|
86 | # If your documentation needs a minimal Sphinx version, state it here. |
---|
87 | #needs_sphinx = '1.0' |
---|
88 | |
---|
89 | # Add any Sphinx extension module names here, as strings. They can be extensions |
---|
90 | # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. |
---|
91 | extensions = ['sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.pngmath', 'sphinx.ext.ifconfig','sphinx.ext.graphviz','sphinx.ext.autodoc'] |
---|
92 | |
---|
93 | |
---|
94 | # Add any paths that contain templates here, relative to this directory. |
---|
95 | templates_path = ['_templates'] |
---|
96 | |
---|
97 | # The suffix of source filenames. |
---|
98 | source_suffix = '.rst' |
---|
99 | |
---|
100 | # The encoding of source files. |
---|
101 | source_encoding = 'iso-8859-15' |
---|
102 | |
---|
103 | # The master toctree document. |
---|
104 | master_doc = 'index' |
---|
105 | |
---|
106 | # General information about the project. |
---|
107 | project = u'TROPFLUX' |
---|
108 | copyright = u'2010, IRD' |
---|
109 | |
---|
110 | # The version info for the project you're documenting, acts as replacement for |
---|
111 | # |version| and |release|, also used in various other places throughout the |
---|
112 | # built documents. |
---|
113 | # |
---|
114 | # The short X.Y version. |
---|
115 | version = '1.0' |
---|
116 | # The full version, including alpha/beta/rc tags. |
---|
117 | release = '1.0' |
---|
118 | |
---|
119 | # The language for content autogenerated by Sphinx. Refer to documentation |
---|
120 | # for a list of supported languages. |
---|
121 | #language = None |
---|
122 | |
---|
123 | # There are two options for replacing |today|: either, you set today to some |
---|
124 | # non-false value, then it is used: |
---|
125 | #today = '' |
---|
126 | # Else, today_fmt is used as the format for a strftime call. |
---|
127 | #today_fmt = '%B %d, %Y' |
---|
128 | |
---|
129 | # List of patterns, relative to source directory, that match files and |
---|
130 | # directories to ignore when looking for source files. |
---|
131 | exclude_patterns = ['guides/README', '_build'] |
---|
132 | |
---|
133 | # The reST default role (used for this markup: `text`) to use for all documents. |
---|
134 | #default_role = None |
---|
135 | |
---|
136 | # If true, '()' will be appended to :func: etc. cross-reference text. |
---|
137 | #add_function_parentheses = True |
---|
138 | |
---|
139 | # If true, the current module name will be prepended to all description |
---|
140 | # unit titles (such as .. function::). |
---|
141 | #add_module_names = True |
---|
142 | |
---|
143 | # If true, sectionauthor and moduleauthor directives will be shown in the |
---|
144 | # output. They are ignored by default. |
---|
145 | #show_authors = False |
---|
146 | |
---|
147 | # The name of the Pygments (syntax highlighting) style to use. |
---|
148 | pygments_style = 'sphinx' |
---|
149 | |
---|
150 | # A list of ignored prefixes for module index sorting. |
---|
151 | #modindex_common_prefix = [] |
---|
152 | |
---|
153 | # graphviz attributes |
---|
154 | inheritance_graph_attrs = dict(rankdir="LR", size='"6.0, 8.0"', |
---|
155 | fontsize=14, ratio='compress') |
---|
156 | |
---|
157 | # -- Options for HTML output --------------------------------------------------- |
---|
158 | |
---|
159 | # The theme to use for HTML and HTML Help pages. See the documentation for |
---|
160 | # a list of builtin themes. |
---|
161 | html_theme = 'default' |
---|
162 | |
---|
163 | # Theme options are theme-specific and customize the look and feel of a theme |
---|
164 | # further. For a list of options available for each theme, see the |
---|
165 | # documentation. |
---|
166 | #html_theme_options = {} |
---|
167 | |
---|
168 | # Add any paths that contain custom themes here, relative to this directory. |
---|
169 | #html_theme_path = [] |
---|
170 | |
---|
171 | # The name for this set of Sphinx documents. If None, it defaults to |
---|
172 | # "<project> v<release> documentation". |
---|
173 | #html_title = None |
---|
174 | |
---|
175 | # A shorter title for the navigation bar. Default is the same as html_title. |
---|
176 | #html_short_title = None |
---|
177 | |
---|
178 | # The name of an image file (relative to this directory) to place at the top |
---|
179 | # of the sidebar. |
---|
180 | #html_logo = None |
---|
181 | |
---|
182 | # The name of an image file (within the static path) to use as favicon of the |
---|
183 | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 |
---|
184 | # pixels large. |
---|
185 | #html_favicon = None |
---|
186 | |
---|
187 | # Add any paths that contain custom static files (such as style sheets) here, |
---|
188 | # relative to this directory. They are copied after the builtin static files, |
---|
189 | # so a file named "default.css" will overwrite the builtin "default.css". |
---|
190 | html_static_path = ['_static'] |
---|
191 | |
---|
192 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
---|
193 | # using the given strftime format. |
---|
194 | #html_last_updated_fmt = '%b %d, %Y' |
---|
195 | |
---|
196 | # If true, SmartyPants will be used to convert quotes and dashes to |
---|
197 | # typographically correct entities. |
---|
198 | #html_use_smartypants = True |
---|
199 | |
---|
200 | # Custom sidebar templates, maps document names to template names. |
---|
201 | #html_sidebars = {} |
---|
202 | |
---|
203 | # Additional templates that should be rendered to pages, maps page names to |
---|
204 | # template names. |
---|
205 | #html_additional_pages = {} |
---|
206 | |
---|
207 | # If false, no module index is generated. |
---|
208 | #html_domain_indices = True |
---|
209 | |
---|
210 | # If false, no index is generated. |
---|
211 | #html_use_index = True |
---|
212 | |
---|
213 | # If true, the index is split into individual pages for each letter. |
---|
214 | #html_split_index = False |
---|
215 | |
---|
216 | # If true, links to the reST sources are added to the pages. |
---|
217 | #html_show_sourcelink = True |
---|
218 | |
---|
219 | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. |
---|
220 | #html_show_sphinx = True |
---|
221 | |
---|
222 | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. |
---|
223 | #html_show_copyright = True |
---|
224 | |
---|
225 | # If true, an OpenSearch description file will be output, and all pages will |
---|
226 | # contain a <link> tag referring to it. The value of this option must be the |
---|
227 | # base URL from which the finished HTML is served. |
---|
228 | #html_use_opensearch = '' |
---|
229 | |
---|
230 | # This is the file name suffix for HTML files (e.g. ".xhtml"). |
---|
231 | #html_file_suffix = None |
---|
232 | |
---|
233 | # Output file base name for HTML help builder. |
---|
234 | htmlhelp_basename = 'TROPFLUXdoc' |
---|
235 | |
---|
236 | |
---|
237 | # -- Options for LaTeX output -------------------------------------------------- |
---|
238 | |
---|
239 | # The paper size ('letter' or 'a4'). |
---|
240 | #latex_paper_size = 'letter' |
---|
241 | |
---|
242 | # The font size ('10pt', '11pt' or '12pt'). |
---|
243 | #latex_font_size = '10pt' |
---|
244 | |
---|
245 | # Grouping the document tree into LaTeX files. List of tuples |
---|
246 | # (source start file, target name, title, author, documentclass [howto/manual]). |
---|
247 | latex_documents = [ |
---|
248 | ('index', 'TROPFLUX.tex', u'TROPFLUX Documentation', u'IRD', 'manual'), |
---|
249 | ('guides/README', 'README.tex', u'TROPFLUX Readme', u'IRD', 'howto'), |
---|
250 | ] |
---|
251 | |
---|
252 | # The name of an image file (relative to this directory) to place at the top of |
---|
253 | # the title page. |
---|
254 | #latex_logo = None |
---|
255 | |
---|
256 | # For "manual" documents, if this is true, then toplevel headings are parts, |
---|
257 | # not chapters. |
---|
258 | #latex_use_parts = False |
---|
259 | |
---|
260 | # If true, show page references after internal links. |
---|
261 | #latex_show_pagerefs = False |
---|
262 | |
---|
263 | # If true, show URL addresses after external links. |
---|
264 | #latex_show_urls = False |
---|
265 | |
---|
266 | # Additional stuff for the LaTeX preamble. |
---|
267 | #latex_preamble = '' |
---|
268 | |
---|
269 | # Documents to append as an appendix to all manuals. |
---|
270 | #latex_appendices = [] |
---|
271 | |
---|
272 | # If false, no module index is generated. |
---|
273 | #latex_domain_indices = True |
---|
274 | |
---|
275 | |
---|
276 | # -- Options for manual page output -------------------------------------------- |
---|
277 | |
---|
278 | # One entry per manual page. List of tuples |
---|
279 | # (source start file, name, description, authors, manual section). |
---|
280 | #++ ('index', 'tropflux', u'TROPFLUX Documentation', [u'IRD'], 1), |
---|
281 | man_pages = [ |
---|
282 | ('tropflux_profile.sh', 'tropflux_profile.sh', u'tropflux_profile Documentation', [u'IRD'], 1), |
---|
283 | ('dlogd.sh', 'dlogd.sh', u'dlogd.sh Documentation', [u'IRD'], 1), |
---|
284 | ('elogd.sh', 'elogd.sh', u'elogd.sh Documentation', [u'IRD'], 1), |
---|
285 | ('plogd.sh', 'plogd.sh', u'plogd.sh Documentation', [u'IRD'], 1), |
---|
286 | ('tlogd.sh', 'tlogd.sh', u'tlogd.sh Documentation', [u'IRD'], 1), |
---|
287 | ('get_oaflux.sh', 'get_oaflux.sh', u'get_oaflux.sh Documentation', [u'IRD'], 1), |
---|
288 | ('get_olr.sh', 'get_olr.sh', u'get_olr.sh Documentation', [u'IRD'], 1), |
---|
289 | ('get_olrnint.sh', 'get_olrnint.sh', u'get_olrnint.sh Documentation', [u'IRD'], 1), |
---|
290 | ('get_pirata_netcdf.sh', 'get_pirata_netcdf.sh', u'get_pirata_netcdf.sh Documentation', [u'IRD'], 1), |
---|
291 | ('get_rama_netcdf.sh', 'get_rama_netcdf.sh', u'get_rama_netcdf.sh Documentation', [u'IRD'], 1), |
---|
292 | ('get_tao_netcdf.sh', 'get_tao_netcdf.sh', u'get_tao_netcdf.sh Documentation', [u'IRD'], 1), |
---|
293 | ('compute_erai_daily_region_2d.sh', 'compute_erai_daily_region_2d.sh', u'compute_erai_daily_region_2d.sh Documentation', [u'IRD'], 1) |
---|
294 | ] |
---|
295 | # |
---|
296 | # intersphinx with saxo |
---|
297 | intersphinx_mapping = {'saxo': ('http://forge.ipsl.jussieu.fr/saxo/download/idldoc_html_output/','saxo.inv'), |
---|
298 | 'nco' : ('http://nco.sourceforge.net/', 'nco.inv'), |
---|
299 | 'cdo' : ('https://code.zmaw.de/embedded/cdo/1.4.7/', 'cdo.inv') |
---|
300 | } |
---|
301 | |
---|