1 | # -*- coding: utf-8 -*- |
---|
2 | # |
---|
3 | # TWICE documentation build configuration file, created by |
---|
4 | # sphinx-quickstart on Wed Mar 24 16:54:51 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 | # |
---|
15 | # TODO |
---|
16 | # ==== |
---|
17 | # |
---|
18 | # - fplod 20100618T151933Z aedon.locean-ipsl.upmc.fr (Darwin) |
---|
19 | # |
---|
20 | # * find a way to produce olr_split.sh.1 even if graphviz inside source |
---|
21 | # * find a way to avoid hard coded man pages name here (should be in |
---|
22 | # adm/makefile) |
---|
23 | # * use a specific index.rst for man troff |
---|
24 | # |
---|
25 | # - fplod 20100610T135910Z aedon.locean-ipsl.upmc.fr (Darwin) |
---|
26 | # |
---|
27 | # * how to detected "Deprecated" sphinx features (this file was created |
---|
28 | # using sphinx 0.6.5 or less |
---|
29 | # |
---|
30 | # EVOLUTIONS |
---|
31 | # ========== |
---|
32 | # |
---|
33 | # $Id$ |
---|
34 | # |
---|
35 | # $URL$ |
---|
36 | # |
---|
37 | # - fplod 20120424 |
---|
38 | # |
---|
39 | # * creation |
---|
40 | # |
---|
41 | #- |
---|
42 | |
---|
43 | import sys, os |
---|
44 | |
---|
45 | # If extensions (or modules to document with autodoc) are in another directory, |
---|
46 | # add these directories to sys.path here. If the directory is relative to the |
---|
47 | # documentation root, use os.path.abspath to make it absolute, like shown here. |
---|
48 | #sys.path.insert(0, os.path.abspath('.')) |
---|
49 | sys.path.insert(0, os.path.abspath('../../../src/')) |
---|
50 | |
---|
51 | # -- General configuration ----------------------------------------------------- |
---|
52 | |
---|
53 | # Add any Sphinx extension module names here, as strings. They can be extensions |
---|
54 | # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. |
---|
55 | #extensions = ['sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.pngmath', 'sphinx.ext.ifconfig'] |
---|
56 | extensions = ['sphinx.ext.autodoc', |
---|
57 | 'sphinx.ext.doctest', |
---|
58 | 'sphinx.ext.todo', |
---|
59 | 'sphinx.ext.intersphinx', |
---|
60 | 'sphinx.ext.coverage', |
---|
61 | 'sphinx.ext.pngmath', |
---|
62 | 'sphinx.ext.ifconfig', |
---|
63 | 'sphinx.ext.viewcode', |
---|
64 | 'sphinx.ext.graphviz', |
---|
65 | 'sphinx.ext.inheritance_diagram' ] |
---|
66 | |
---|
67 | # Add any paths that contain templates here, relative to this directory. |
---|
68 | templates_path = ['_templates'] |
---|
69 | |
---|
70 | # The suffix of source filenames. |
---|
71 | source_suffix = '.rst' |
---|
72 | |
---|
73 | # The encoding of source files. |
---|
74 | source_encoding = 'iso-8859-15' |
---|
75 | |
---|
76 | # The master toctree document. |
---|
77 | master_doc = 'index' |
---|
78 | |
---|
79 | # General information about the project. |
---|
80 | project = u'TWICE' |
---|
81 | copyright = u'2008, 2009, 2010, 2011, 2012, CNRS' |
---|
82 | |
---|
83 | # The version info for the project you're documenting, acts as replacement for |
---|
84 | # |version| and |release|, also used in various other places throughout the |
---|
85 | # built documents. |
---|
86 | # |
---|
87 | # The short X.Y version. |
---|
88 | version = '0.1.0' |
---|
89 | # The full version, including alpha/beta/rc tags. |
---|
90 | release = '0.1.0' |
---|
91 | |
---|
92 | # The language for content autogenerated by Sphinx. Refer to documentation |
---|
93 | # for a list of supported languages. |
---|
94 | #language = None |
---|
95 | |
---|
96 | # There are two options for replacing |today|: either, you set today to some |
---|
97 | # non-false value, then it is used: |
---|
98 | #today = '' |
---|
99 | # Else, today_fmt is used as the format for a strftime call. |
---|
100 | #today_fmt = '%Y%m%d' |
---|
101 | |
---|
102 | # List of directories, relative to source directory, that shouldn't be searched |
---|
103 | # for source files. |
---|
104 | exclude_patterns = ['_build', 'prolog.rst'] |
---|
105 | |
---|
106 | # Included at the beginning of every source file that is read. |
---|
107 | with open('prolog.rst', 'r') as pr: |
---|
108 | rst_prolog = pr.read() |
---|
109 | |
---|
110 | rst_prolog |
---|
111 | |
---|
112 | # The reST default role (used for this markup: `text`) to use for all documents. |
---|
113 | #default_role = None |
---|
114 | |
---|
115 | # If true, '()' will be appended to :func: etc. cross-reference text. |
---|
116 | #add_function_parentheses = True |
---|
117 | |
---|
118 | # If true, the current module name will be prepended to all description |
---|
119 | # unit titles (such as .. function::). |
---|
120 | add_module_names = True |
---|
121 | |
---|
122 | # If true, sectionauthor and moduleauthor directives will be shown in the |
---|
123 | # output. They are ignored by default. |
---|
124 | #show_authors = False |
---|
125 | |
---|
126 | # The name of the Pygments (syntax highlighting) style to use. |
---|
127 | pygments_style = 'sphinx' |
---|
128 | |
---|
129 | # A list of ignored prefixes for module index sorting. |
---|
130 | #modindex_common_prefix = [] |
---|
131 | |
---|
132 | todo_include_todos = True |
---|
133 | |
---|
134 | # graphviz attributes |
---|
135 | inheritance_graph_attrs = dict(rankdir="LR", size='"6.0, 8.0"', |
---|
136 | fontsize=14, ratio='compress') |
---|
137 | |
---|
138 | # Warn about all references where the target cannot be found. |
---|
139 | nitpicky = True |
---|
140 | |
---|
141 | # -- Options for HTML output --------------------------------------------------- |
---|
142 | |
---|
143 | # The theme to use for HTML and HTML Help pages. Major themes that come with |
---|
144 | # Sphinx are currently 'default' and 'sphinxdoc'. |
---|
145 | html_theme = 'default' |
---|
146 | |
---|
147 | # Theme options are theme-specific and customize the look and feel of a theme |
---|
148 | # further. For a list of options available for each theme, see the |
---|
149 | # documentation. |
---|
150 | #html_theme_options = {} |
---|
151 | |
---|
152 | # Add any paths that contain custom themes here, relative to this directory. |
---|
153 | #html_theme_path = [] |
---|
154 | |
---|
155 | # The name for this set of Sphinx documents. If None, it defaults to |
---|
156 | # "<project> v<release> documentation". |
---|
157 | #html_title = None |
---|
158 | |
---|
159 | # A shorter title for the navigation bar. Default is the same as html_title. |
---|
160 | #html_short_title = None |
---|
161 | |
---|
162 | # The name of an image file (relative to this directory) to place at the top |
---|
163 | # of the sidebar. |
---|
164 | #html_logo = None |
---|
165 | |
---|
166 | # The name of an image file (within the static path) to use as favicon of the |
---|
167 | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 |
---|
168 | # pixels large. |
---|
169 | #html_favicon = None |
---|
170 | |
---|
171 | # Add any paths that contain custom static files (such as style sheets) here, |
---|
172 | # relative to this directory. They are copied after the builtin static files, |
---|
173 | # so a file named "default.css" will overwrite the builtin "default.css". |
---|
174 | html_static_path = ['_static'] |
---|
175 | |
---|
176 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
---|
177 | # using the given strftime format. |
---|
178 | #html_last_updated_fmt = '%b %d, %Y' |
---|
179 | |
---|
180 | # If true, SmartyPants will be used to convert quotes and dashes to |
---|
181 | # typographically correct entities. |
---|
182 | #html_use_smartypants = True |
---|
183 | |
---|
184 | # Custom sidebar templates, maps document names to template names. |
---|
185 | #html_sidebars = {} |
---|
186 | |
---|
187 | # Additional templates that should be rendered to pages, maps page names to |
---|
188 | # template names. |
---|
189 | #html_additional_pages = {} |
---|
190 | |
---|
191 | # If false, no module index is generated. |
---|
192 | #html_domain_indices = True |
---|
193 | |
---|
194 | # If false, no index is generated. |
---|
195 | #html_use_index = True |
---|
196 | |
---|
197 | # If true, the index is split into individual pages for each letter. |
---|
198 | #html_split_index = False |
---|
199 | |
---|
200 | # If true, links to the reST sources are added to the pages. |
---|
201 | #html_show_sourcelink = True |
---|
202 | |
---|
203 | #html_show_sphinx = True |
---|
204 | #html_show_copyright = True |
---|
205 | |
---|
206 | # If true, an OpenSearch description file will be output, and all pages will |
---|
207 | # contain a <link> tag referring to it. The value of this option must be the |
---|
208 | # base URL from which the finished HTML is served. |
---|
209 | #html_use_opensearch = '' |
---|
210 | |
---|
211 | # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). |
---|
212 | #html_file_suffix = '' |
---|
213 | |
---|
214 | # Output file base name for HTML help builder. |
---|
215 | htmlhelp_basename = 'TWICEdoc' |
---|
216 | |
---|
217 | |
---|
218 | # -- Options for LaTeX output -------------------------------------------------- |
---|
219 | |
---|
220 | # The paper size ('letter' or 'a4'). |
---|
221 | #latex_paper_size = 'letter' |
---|
222 | |
---|
223 | # The font size ('10pt', '11pt' or '12pt'). |
---|
224 | #latex_font_size = '10pt' |
---|
225 | |
---|
226 | # Grouping the document tree into LaTeX files. List of tuples |
---|
227 | # (source start file, target name, title, author, documentclass [howto/manual]). |
---|
228 | latex_documents = [ |
---|
229 | ('index', 'twice_dev.tex', u'TWICE developpers documentation', u'CNRS', 'manual'), |
---|
230 | ] |
---|
231 | |
---|
232 | # The name of an image file (relative to this directory) to place at the top of |
---|
233 | # the title page. |
---|
234 | #latex_logo = None |
---|
235 | |
---|
236 | # For "manual" documents, if this is true, then toplevel headings are parts, |
---|
237 | # not chapters. |
---|
238 | #latex_use_parts = 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). |
---|
254 | man_pages = [ |
---|
255 | ('index', project, u'TWICE developpers documentation', [u'fp'], 1), |
---|
256 | ('cat_clim_ecmwf.sh', 'cat_clim_ecmwf.sh', u'cat_clim_ecmwf.sh Documentation', [u'fp'], 1), |
---|
257 | ('cat_clim_olr.sh', 'cat_clim_olr.sh', u'cat_clim_olr.sh Documentation', [u'fp'], 1), |
---|
258 | ('create_gif.sh', 'create_gif.sh', u'create_gif.sh Documentation', [u'fp'], 1), |
---|
259 | ('concat-files.sh', 'concat-files.sh', u'concat-files.sh Documentation', [u'fp'], 1), |
---|
260 | ('create_nc.sh', 'create_nc.sh', u'create_nc.sh Documentation', [u'fp'], 1), |
---|
261 | ('dlogd.sh', 'dlogd.sh', u'dlogd.sh Documentation', [u'fp'], 1), |
---|
262 | ('elogd.sh', 'elogd.sh', u'elogd.sh Documentation', [u'fp'], 1), |
---|
263 | ('plogd.sh', 'plogd.sh', u'plogd.sh Documentation', [u'fp'], 1), |
---|
264 | ('tlogd.sh', 'tlogd.sh', u'tlogd.sh Documentation', [u'fp'], 1), |
---|
265 | ('is_leap_year.sh', 'is_leap_year.sh', u'is_leap_year.sh Documentation', [u'fp'], 1), |
---|
266 | ('olr_split.sh', 'olr_split.sh', u'olr_split.sh Documentation', [u'fp'], 1), |
---|
267 | ('paper01_pre.sh', 'paper01_pre.sh', u'paper01_pre.sh Documentation', [u'fp'], 1), |
---|
268 | ('traite_amsuab.sh', 'traite_amsuab.sh', u'traite_amsuab.sh Documentation', [u'fp'], 1), |
---|
269 | ('traite_msg-prod.sh', 'traite_msg-prod.sh', u'traite_msg-prod.sh Documentation', [u'fp'], 1), |
---|
270 | ('aramma_profile.sh', 'project_profile.sh', u'project_profile.sh Documentation', [u'fp'], 1), |
---|
271 | ('script_cat_climeraint2d.sh', 'script_cat_climeraint2d.sh', u'script_cat_climeraint2d.sh Documentation', [u'fp'], 1), |
---|
272 | ('get_msg.sh', 'get_msg.sh', u'get_msg.sh Documentation', [u'fp'], 1), |
---|
273 | ('get_amsu.sh', 'get_amsu.sh', u'get_amsu.sh Documentation', [u'fp'], 1), |
---|
274 | ('extract_zone_nc.sh', 'extract_zone_nc.sh', u'extract_zone_nc.sh Documentation', [u'fp'], 1), |
---|
275 | ] |
---|
276 | |
---|
277 | # intersphinx |
---|
278 | intersphinx_mapping = {'fptools' : ('http://www.locean-ipsl.upmc.fr/~fplod/fptools/fptools_ws/doc/html/', None)} |
---|