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