michael@0: # -*- coding: utf-8 -*-
michael@0: #
michael@0: # Mock documentation build configuration file, created by
michael@0: # sphinx-quickstart on Mon Nov 17 18:12:00 2008.
michael@0: #
michael@0: # This file is execfile()d with the current directory set to its containing dir.
michael@0: #
michael@0: # The contents of this file are pickled, so don't put values in the namespace
michael@0: # that aren't pickleable (module imports are okay, they're removed automatically).
michael@0: #
michael@0: # All configuration values have a default value; values that are commented out
michael@0: # serve to show the default value.
michael@0: 
michael@0: import sys, os
michael@0: sys.path.insert(0, os.path.abspath('..'))
michael@0: from mock import __version__
michael@0: 
michael@0: # If your extensions are in another directory, add it here. If the directory
michael@0: # is relative to the documentation root, use os.path.abspath to make it
michael@0: # absolute, like shown here.
michael@0: #sys.path.append(os.path.abspath('some/directory'))
michael@0: 
michael@0: # General configuration
michael@0: # ---------------------
michael@0: 
michael@0: # Add any Sphinx extension module names here, as strings. They can be extensions
michael@0: # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
michael@0: extensions = ['sphinx.ext.doctest']
michael@0: 
michael@0: doctest_global_setup = """
michael@0: import os
michael@0: import sys
michael@0: import mock
michael@0: from mock import * # yeah, I know :-/
michael@0: import unittest2
michael@0: import __main__
michael@0: 
michael@0: if os.getcwd() not in sys.path:
michael@0:     sys.path.append(os.getcwd())
michael@0: 
michael@0: # keep a reference to __main__
michael@0: sys.modules['__main'] = __main__
michael@0: 
michael@0: class ProxyModule(object):
michael@0:     def __init__(self):
michael@0:         self.__dict__ = globals()
michael@0: 
michael@0: sys.modules['__main__'] = ProxyModule()
michael@0: """
michael@0: 
michael@0: doctest_global_cleanup = """
michael@0: sys.modules['__main__'] = sys.modules['__main']
michael@0: """
michael@0: 
michael@0: html_theme = 'nature'
michael@0: html_theme_options = {}
michael@0: 
michael@0: # Add any paths that contain templates here, relative to this directory.
michael@0: #templates_path = ['_templates']
michael@0: 
michael@0: # The suffix of source filenames.
michael@0: source_suffix = '.txt'
michael@0: 
michael@0: # The master toctree document.
michael@0: master_doc = 'index'
michael@0: 
michael@0: # General substitutions.
michael@0: project = u'Mock'
michael@0: copyright = u'2007-2012, Michael Foord & the mock team'
michael@0: 
michael@0: # The default replacements for |version| and |release|, also used in various
michael@0: # other places throughout the built documents.
michael@0: #
michael@0: # The short X.Y version.
michael@0: version = __version__[:3]
michael@0: # The full version, including alpha/beta/rc tags.
michael@0: release = __version__
michael@0: 
michael@0: # There are two options for replacing |today|: either, you set today to some
michael@0: # non-false value, then it is used:
michael@0: #today = ''
michael@0: # Else, today_fmt is used as the format for a strftime call.
michael@0: today_fmt = '%B %d, %Y'
michael@0: 
michael@0: # List of documents that shouldn't be included in the build.
michael@0: #unused_docs = []
michael@0: 
michael@0: # List of directories, relative to source directories, that shouldn't be searched
michael@0: # for source files.
michael@0: exclude_trees = []
michael@0: 
michael@0: # The reST default role (used for this markup: `text`) to use for all documents.
michael@0: #default_role = None
michael@0: 
michael@0: # If true, '()' will be appended to :func: etc. cross-reference text.
michael@0: #add_function_parentheses = True
michael@0: 
michael@0: # If true, the current module name will be prepended to all description
michael@0: # unit titles (such as .. function::).
michael@0: add_module_names = False
michael@0: 
michael@0: # If true, sectionauthor and moduleauthor directives will be shown in the
michael@0: # output. They are ignored by default.
michael@0: #show_authors = False
michael@0: 
michael@0: # The name of the Pygments (syntax highlighting) style to use.
michael@0: pygments_style = 'friendly'
michael@0: 
michael@0: 
michael@0: # Options for HTML output
michael@0: # -----------------------
michael@0: 
michael@0: # The style sheet to use for HTML and HTML Help pages. A file of that name
michael@0: # must exist either in Sphinx' static/ path, or in one of the custom paths
michael@0: # given in html_static_path.
michael@0: #html_style = 'adctheme.css'
michael@0: 
michael@0: # The name for this set of Sphinx documents.  If None, it defaults to
michael@0: # "<project> v<release> documentation".
michael@0: #html_title = None
michael@0: 
michael@0: # A shorter title for the navigation bar.  Default is the same as html_title.
michael@0: #html_short_title = None
michael@0: 
michael@0: # The name of an image file (relative to this directory) to place at the top
michael@0: # of the sidebar.
michael@0: #html_logo = None
michael@0: 
michael@0: # The name of an image file (within the static path) to use as favicon of the
michael@0: # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
michael@0: # pixels large.
michael@0: #html_favicon = None
michael@0: 
michael@0: # Add any paths that contain custom static files (such as style sheets) here,
michael@0: # relative to this directory. They are copied after the builtin static files,
michael@0: # so a file named "default.css" will overwrite the builtin "default.css".
michael@0: #html_static_path = ['_static']
michael@0: 
michael@0: # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
michael@0: # using the given strftime format.
michael@0: html_last_updated_fmt = '%b %d, %Y'
michael@0: 
michael@0: # If true, SmartyPants will be used to convert quotes and dashes to
michael@0: # typographically correct entities.
michael@0: #html_use_smartypants = True
michael@0: 
michael@0: # Custom sidebar templates, maps document names to template names.
michael@0: #html_sidebars = {}
michael@0: 
michael@0: # Additional templates that should be rendered to pages, maps page names to
michael@0: # template names.
michael@0: #html_additional_pages = {}
michael@0: 
michael@0: # If false, no module index is generated.
michael@0: html_use_modindex = False
michael@0: 
michael@0: # If false, no index is generated.
michael@0: #html_use_index = True
michael@0: 
michael@0: # If true, the index is split into individual pages for each letter.
michael@0: #html_split_index = False
michael@0: 
michael@0: # If true, the reST sources are included in the HTML build as _sources/<name>.
michael@0: #html_copy_source = True
michael@0: 
michael@0: # If true, an OpenSearch description file will be output, and all pages will
michael@0: # contain a <link> tag referring to it.  The value of this option must be the
michael@0: # base URL from which the finished HTML is served.
michael@0: #html_use_opensearch = ''
michael@0: 
michael@0: # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
michael@0: #html_file_suffix = ''
michael@0: 
michael@0: # Output file base name for HTML help builder.
michael@0: htmlhelp_basename = 'Mockdoc'
michael@0: 
michael@0: 
michael@0: # Options for LaTeX output
michael@0: # ------------------------
michael@0: 
michael@0: # The paper size ('letter' or 'a4').
michael@0: #latex_paper_size = 'letter'
michael@0: 
michael@0: # The font size ('10pt', '11pt' or '12pt').
michael@0: latex_font_size = '12pt'
michael@0: 
michael@0: # Grouping the document tree into LaTeX files. List of tuples
michael@0: # (source start file, target name, title, author, document class [howto/manual]).
michael@0: latex_documents = [
michael@0:   ('index', 'Mock.tex', u'Mock Documentation',
michael@0:    u'Michael Foord', 'manual'),
michael@0: ]
michael@0: 
michael@0: # The name of an image file (relative to this directory) to place at the top of
michael@0: # the title page.
michael@0: #latex_logo = None
michael@0: 
michael@0: # For "manual" documents, if this is true, then toplevel headings are parts,
michael@0: # not chapters.
michael@0: #latex_use_parts = False
michael@0: 
michael@0: # Additional stuff for the LaTeX preamble.
michael@0: #latex_preamble = ''
michael@0: 
michael@0: # Documents to append as an appendix to all manuals.
michael@0: #latex_appendices = []
michael@0: 
michael@0: # If false, no module index is generated.
michael@0: latex_use_modindex = False