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