conf.py~

Thu, 29 Mar 2012 16:32:05 +0200

author
ulalume3 <binietoglou@imaa.cnr.it>
date
Thu, 29 Mar 2012 16:32:05 +0200
changeset 3
ba31b26b041b
parent 2
3ec57ace6912
permissions
-rw-r--r--

New doc structure

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

mercurial