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