binietoglou@0: # -*- coding: utf-8 -*- binietoglou@0: # binietoglou@0: # Single Calculus Chain documentation build configuration file, created by binietoglou@0: # sphinx-quickstart on Thu Mar 15 10:35:01 2012. binietoglou@0: # binietoglou@0: # This file is execfile()d with the current directory set to its containing dir. binietoglou@0: # binietoglou@0: # Note that not all possible configuration values are present in this binietoglou@0: # autogenerated file. binietoglou@0: # binietoglou@0: # All configuration values have a default; values that are commented out binietoglou@0: # serve to show the default. binietoglou@0: binietoglou@0: import sys, os binietoglou@0: binietoglou@0: # If extensions (or modules to document with autodoc) are in another directory, binietoglou@0: # add these directories to sys.path here. If the directory is relative to the binietoglou@0: # documentation root, use os.path.abspath to make it absolute, like shown here. binietoglou@0: #sys.path.insert(0, os.path.abspath('.')) binietoglou@0: binietoglou@0: # -- General configuration ----------------------------------------------------- binietoglou@0: binietoglou@0: # If your documentation needs a minimal Sphinx version, state it here. binietoglou@0: #needs_sphinx = '1.0' binietoglou@0: binietoglou@0: # Add any Sphinx extension module names here, as strings. They can be extensions binietoglou@0: # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. binietoglou@0: extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.mathjax'] binietoglou@0: binietoglou@0: # Add any paths that contain templates here, relative to this directory. binietoglou@0: templates_path = ['aux_templates'] binietoglou@0: binietoglou@0: # The suffix of source filenames. binietoglou@0: source_suffix = '.rst' binietoglou@0: binietoglou@0: # The encoding of source files. binietoglou@0: #source_encoding = 'utf-8-sig' binietoglou@0: binietoglou@0: # The master toctree document. binietoglou@0: master_doc = 'index' binietoglou@0: binietoglou@0: # General information about the project. binietoglou@0: project = u'Single Calculus Chain' binietoglou@0: copyright = u'2012, SCC team' binietoglou@0: binietoglou@0: # The version info for the project you're documenting, acts as replacement for binietoglou@0: # |version| and |release|, also used in various other places throughout the binietoglou@0: # built documents. binietoglou@0: # binietoglou@0: # The short X.Y version. binietoglou@0: version = '0.2' binietoglou@0: # The full version, including alpha/beta/rc tags. binietoglou@0: release = '0.2' binietoglou@0: binietoglou@0: # The language for content autogenerated by Sphinx. Refer to documentation binietoglou@0: # for a list of supported languages. binietoglou@0: #language = None binietoglou@0: binietoglou@0: # There are two options for replacing |today|: either, you set today to some binietoglou@0: # non-false value, then it is used: binietoglou@0: #today = '' binietoglou@0: # Else, today_fmt is used as the format for a strftime call. binietoglou@0: #today_fmt = '%B %d, %Y' binietoglou@0: binietoglou@0: # List of patterns, relative to source directory, that match files and binietoglou@0: # directories to ignore when looking for source files. binietoglou@0: exclude_patterns = ['aux_build'] binietoglou@0: binietoglou@0: # The reST default role (used for this markup: `text`) to use for all documents. binietoglou@0: #default_role = None binietoglou@0: binietoglou@0: # If true, '()' will be appended to :func: etc. cross-reference text. binietoglou@0: #add_function_parentheses = True binietoglou@0: binietoglou@0: # If true, the current module name will be prepended to all description binietoglou@0: # unit titles (such as .. function::). binietoglou@0: #add_module_names = True binietoglou@0: binietoglou@0: # If true, sectionauthor and moduleauthor directives will be shown in the binietoglou@0: # output. They are ignored by default. binietoglou@0: #show_authors = False binietoglou@0: binietoglou@0: # The name of the Pygments (syntax highlighting) style to use. binietoglou@0: pygments_style = 'sphinx' binietoglou@0: binietoglou@0: # A list of ignored prefixes for module index sorting. binietoglou@0: #modindex_common_prefix = [] binietoglou@0: binietoglou@0: binietoglou@0: # -- Options for HTML output --------------------------------------------------- binietoglou@0: binietoglou@0: # The theme to use for HTML and HTML Help pages. See the documentation for binietoglou@0: # a list of builtin themes. binietoglou@0: html_theme = 'nature' binietoglou@0: binietoglou@0: # Theme options are theme-specific and customize the look and feel of a theme binietoglou@0: # further. For a list of options available for each theme, see the binietoglou@0: # documentation. binietoglou@0: #html_theme_options = {} binietoglou@0: binietoglou@0: # Add any paths that contain custom themes here, relative to this directory. binietoglou@0: #html_theme_path = [] binietoglou@0: binietoglou@0: # The name for this set of Sphinx documents. If None, it defaults to binietoglou@0: # " v documentation". binietoglou@0: #html_title = None binietoglou@0: binietoglou@0: # A shorter title for the navigation bar. Default is the same as html_title. binietoglou@0: #html_short_title = None binietoglou@0: binietoglou@0: # The name of an image file (relative to this directory) to place at the top binietoglou@0: # of the sidebar. binietoglou@0: #html_logo = None binietoglou@0: binietoglou@0: # The name of an image file (within the static path) to use as favicon of the binietoglou@0: # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 binietoglou@0: # pixels large. binietoglou@0: #html_favicon = None binietoglou@0: binietoglou@0: # Add any paths that contain custom static files (such as style sheets) here, binietoglou@0: # relative to this directory. They are copied after the builtin static files, binietoglou@0: # so a file named "default.css" will overwrite the builtin "default.css". binietoglou@0: html_static_path = ['aux_static'] binietoglou@0: binietoglou@0: # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, binietoglou@0: # using the given strftime format. binietoglou@0: #html_last_updated_fmt = '%b %d, %Y' binietoglou@0: binietoglou@0: # If true, SmartyPants will be used to convert quotes and dashes to binietoglou@0: # typographically correct entities. binietoglou@0: #html_use_smartypants = True binietoglou@0: binietoglou@0: # Custom sidebar templates, maps document names to template names. binietoglou@0: #html_sidebars = {} binietoglou@0: binietoglou@0: # Additional templates that should be rendered to pages, maps page names to binietoglou@0: # template names. binietoglou@0: #html_additional_pages = {} binietoglou@0: binietoglou@0: # If false, no module index is generated. binietoglou@0: #html_domain_indices = True binietoglou@0: binietoglou@0: # If false, no index is generated. binietoglou@0: #html_use_index = True binietoglou@0: binietoglou@0: # If true, the index is split into individual pages for each letter. binietoglou@0: #html_split_index = False binietoglou@0: binietoglou@0: # If true, links to the reST sources are added to the pages. binietoglou@0: #html_show_sourcelink = True binietoglou@0: binietoglou@0: # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. binietoglou@0: #html_show_sphinx = True binietoglou@0: binietoglou@0: # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. binietoglou@0: #html_show_copyright = True binietoglou@0: binietoglou@0: # If true, an OpenSearch description file will be output, and all pages will binietoglou@0: # contain a tag referring to it. The value of this option must be the binietoglou@0: # base URL from which the finished HTML is served. binietoglou@0: #html_use_opensearch = '' binietoglou@0: binietoglou@0: # This is the file name suffix for HTML files (e.g. ".xhtml"). binietoglou@0: #html_file_suffix = None binietoglou@0: binietoglou@0: # Output file base name for HTML help builder. binietoglou@0: htmlhelp_basename = 'SingleCalculusChaindoc' binietoglou@0: binietoglou@0: binietoglou@0: # -- Options for LaTeX output -------------------------------------------------- binietoglou@0: binietoglou@0: latex_elements = { binietoglou@0: # The paper size ('letterpaper' or 'a4paper'). binietoglou@0: #'papersize': 'letterpaper', binietoglou@0: binietoglou@0: # The font size ('10pt', '11pt' or '12pt'). binietoglou@0: #'pointsize': '10pt', binietoglou@0: binietoglou@0: # Additional stuff for the LaTeX preamble. binietoglou@0: #'preamble': '', binietoglou@0: } binietoglou@0: binietoglou@0: # Grouping the document tree into LaTeX files. List of tuples binietoglou@0: # (source start file, target name, title, author, documentclass [howto/manual]). binietoglou@0: latex_documents = [ binietoglou@0: ('index', 'SingleCalculusChain.tex', u'Single Calculus Chain Documentation', binietoglou@0: u'SCC team', 'manual'), binietoglou@0: ] binietoglou@0: binietoglou@0: # The name of an image file (relative to this directory) to place at the top of binietoglou@0: # the title page. binietoglou@0: #latex_logo = None binietoglou@0: binietoglou@0: # For "manual" documents, if this is true, then toplevel headings are parts, binietoglou@0: # not chapters. binietoglou@0: #latex_use_parts = False binietoglou@0: binietoglou@0: # If true, show page references after internal links. binietoglou@0: #latex_show_pagerefs = False binietoglou@0: binietoglou@0: # If true, show URL addresses after external links. binietoglou@0: #latex_show_urls = False binietoglou@0: binietoglou@0: # Documents to append as an appendix to all manuals. binietoglou@0: #latex_appendices = [] binietoglou@0: binietoglou@0: # If false, no module index is generated. binietoglou@0: #latex_domain_indices = True binietoglou@0: binietoglou@0: binietoglou@0: # -- Options for manual page output -------------------------------------------- binietoglou@0: binietoglou@0: # One entry per manual page. List of tuples binietoglou@0: # (source start file, name, description, authors, manual section). binietoglou@0: man_pages = [ binietoglou@0: ('index', 'singlecalculuschain', u'Single Calculus Chain Documentation', binietoglou@0: [u'SCC team'], 1) binietoglou@0: ] binietoglou@0: binietoglou@0: # If true, show URL addresses after external links. binietoglou@0: #man_show_urls = False binietoglou@0: binietoglou@0: binietoglou@0: # -- Options for Texinfo output ------------------------------------------------ binietoglou@0: binietoglou@0: # Grouping the document tree into Texinfo files. List of tuples binietoglou@0: # (source start file, target name, title, author, binietoglou@0: # dir menu entry, description, category) binietoglou@0: texinfo_documents = [ binietoglou@0: ('index', 'SingleCalculusChain', u'Single Calculus Chain Documentation', binietoglou@0: u'SCC team', 'SingleCalculusChain', 'One line description of project.', binietoglou@0: 'Miscellaneous'), binietoglou@0: ] binietoglou@0: binietoglou@0: # Documents to append as an appendix to all manuals. binietoglou@0: #texinfo_appendices = [] binietoglou@0: binietoglou@0: # If false, no module index is generated. binietoglou@0: #texinfo_domain_indices = True binietoglou@0: binietoglou@0: # How to display URL addresses: 'footnote', 'no', or 'inline'. binietoglou@0: #texinfo_show_urls = 'footnote' binietoglou@0: binietoglou@0: binietoglou@0: # -- Options for Epub output --------------------------------------------------- binietoglou@0: binietoglou@0: # Bibliographic Dublin Core info. binietoglou@0: epub_title = u'Single Calculus Chain' binietoglou@0: epub_author = u'SCC team' binietoglou@0: epub_publisher = u'SCC team' binietoglou@0: epub_copyright = u'2012, SCC team' binietoglou@0: binietoglou@0: # The language of the text. It defaults to the language option binietoglou@0: # or en if the language is not set. binietoglou@0: #epub_language = '' binietoglou@0: binietoglou@0: # The scheme of the identifier. Typical schemes are ISBN or URL. binietoglou@0: #epub_scheme = '' binietoglou@0: binietoglou@0: # The unique identifier of the text. This can be a ISBN number binietoglou@0: # or the project homepage. binietoglou@0: #epub_identifier = '' binietoglou@0: binietoglou@0: # A unique identification for the text. binietoglou@0: #epub_uid = '' binietoglou@0: binietoglou@0: # A tuple containing the cover image and cover page html template filenames. binietoglou@0: #epub_cover = () binietoglou@0: binietoglou@0: # HTML files that should be inserted before the pages created by sphinx. binietoglou@0: # The format is a list of tuples containing the path and title. binietoglou@0: #epub_pre_files = [] binietoglou@0: binietoglou@0: # HTML files shat should be inserted after the pages created by sphinx. binietoglou@0: # The format is a list of tuples containing the path and title. binietoglou@0: #epub_post_files = [] binietoglou@0: binietoglou@0: # A list of files that should not be packed into the epub file. binietoglou@0: #epub_exclude_files = [] binietoglou@0: binietoglou@0: # The depth of the table of contents in toc.ncx. binietoglou@0: #epub_tocdepth = 3 binietoglou@0: binietoglou@0: # Allow duplicate toc entries. binietoglou@0: #epub_tocdup = True binietoglou@0: binietoglou@0: binietoglou@0: # Example configuration for intersphinx: refer to the Python standard library. binietoglou@0: intersphinx_mapping = {'http://docs.python.org/': None}