1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/python/mock-1.0.0/docs/conf.py Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,209 @@
1.4 +# -*- coding: utf-8 -*-
1.5 +#
1.6 +# Mock documentation build configuration file, created by
1.7 +# sphinx-quickstart on Mon Nov 17 18:12:00 2008.
1.8 +#
1.9 +# This file is execfile()d with the current directory set to its containing dir.
1.10 +#
1.11 +# The contents of this file are pickled, so don't put values in the namespace
1.12 +# that aren't pickleable (module imports are okay, they're removed automatically).
1.13 +#
1.14 +# All configuration values have a default value; values that are commented out
1.15 +# serve to show the default value.
1.16 +
1.17 +import sys, os
1.18 +sys.path.insert(0, os.path.abspath('..'))
1.19 +from mock import __version__
1.20 +
1.21 +# If your extensions are in another directory, add it here. If the directory
1.22 +# is relative to the documentation root, use os.path.abspath to make it
1.23 +# absolute, like shown here.
1.24 +#sys.path.append(os.path.abspath('some/directory'))
1.25 +
1.26 +# General configuration
1.27 +# ---------------------
1.28 +
1.29 +# Add any Sphinx extension module names here, as strings. They can be extensions
1.30 +# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
1.31 +extensions = ['sphinx.ext.doctest']
1.32 +
1.33 +doctest_global_setup = """
1.34 +import os
1.35 +import sys
1.36 +import mock
1.37 +from mock import * # yeah, I know :-/
1.38 +import unittest2
1.39 +import __main__
1.40 +
1.41 +if os.getcwd() not in sys.path:
1.42 + sys.path.append(os.getcwd())
1.43 +
1.44 +# keep a reference to __main__
1.45 +sys.modules['__main'] = __main__
1.46 +
1.47 +class ProxyModule(object):
1.48 + def __init__(self):
1.49 + self.__dict__ = globals()
1.50 +
1.51 +sys.modules['__main__'] = ProxyModule()
1.52 +"""
1.53 +
1.54 +doctest_global_cleanup = """
1.55 +sys.modules['__main__'] = sys.modules['__main']
1.56 +"""
1.57 +
1.58 +html_theme = 'nature'
1.59 +html_theme_options = {}
1.60 +
1.61 +# Add any paths that contain templates here, relative to this directory.
1.62 +#templates_path = ['_templates']
1.63 +
1.64 +# The suffix of source filenames.
1.65 +source_suffix = '.txt'
1.66 +
1.67 +# The master toctree document.
1.68 +master_doc = 'index'
1.69 +
1.70 +# General substitutions.
1.71 +project = u'Mock'
1.72 +copyright = u'2007-2012, Michael Foord & the mock team'
1.73 +
1.74 +# The default replacements for |version| and |release|, also used in various
1.75 +# other places throughout the built documents.
1.76 +#
1.77 +# The short X.Y version.
1.78 +version = __version__[:3]
1.79 +# The full version, including alpha/beta/rc tags.
1.80 +release = __version__
1.81 +
1.82 +# There are two options for replacing |today|: either, you set today to some
1.83 +# non-false value, then it is used:
1.84 +#today = ''
1.85 +# Else, today_fmt is used as the format for a strftime call.
1.86 +today_fmt = '%B %d, %Y'
1.87 +
1.88 +# List of documents that shouldn't be included in the build.
1.89 +#unused_docs = []
1.90 +
1.91 +# List of directories, relative to source directories, that shouldn't be searched
1.92 +# for source files.
1.93 +exclude_trees = []
1.94 +
1.95 +# The reST default role (used for this markup: `text`) to use for all documents.
1.96 +#default_role = None
1.97 +
1.98 +# If true, '()' will be appended to :func: etc. cross-reference text.
1.99 +#add_function_parentheses = True
1.100 +
1.101 +# If true, the current module name will be prepended to all description
1.102 +# unit titles (such as .. function::).
1.103 +add_module_names = False
1.104 +
1.105 +# If true, sectionauthor and moduleauthor directives will be shown in the
1.106 +# output. They are ignored by default.
1.107 +#show_authors = False
1.108 +
1.109 +# The name of the Pygments (syntax highlighting) style to use.
1.110 +pygments_style = 'friendly'
1.111 +
1.112 +
1.113 +# Options for HTML output
1.114 +# -----------------------
1.115 +
1.116 +# The style sheet to use for HTML and HTML Help pages. A file of that name
1.117 +# must exist either in Sphinx' static/ path, or in one of the custom paths
1.118 +# given in html_static_path.
1.119 +#html_style = 'adctheme.css'
1.120 +
1.121 +# The name for this set of Sphinx documents. If None, it defaults to
1.122 +# "<project> v<release> documentation".
1.123 +#html_title = None
1.124 +
1.125 +# A shorter title for the navigation bar. Default is the same as html_title.
1.126 +#html_short_title = None
1.127 +
1.128 +# The name of an image file (relative to this directory) to place at the top
1.129 +# of the sidebar.
1.130 +#html_logo = None
1.131 +
1.132 +# The name of an image file (within the static path) to use as favicon of the
1.133 +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
1.134 +# pixels large.
1.135 +#html_favicon = None
1.136 +
1.137 +# Add any paths that contain custom static files (such as style sheets) here,
1.138 +# relative to this directory. They are copied after the builtin static files,
1.139 +# so a file named "default.css" will overwrite the builtin "default.css".
1.140 +#html_static_path = ['_static']
1.141 +
1.142 +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
1.143 +# using the given strftime format.
1.144 +html_last_updated_fmt = '%b %d, %Y'
1.145 +
1.146 +# If true, SmartyPants will be used to convert quotes and dashes to
1.147 +# typographically correct entities.
1.148 +#html_use_smartypants = True
1.149 +
1.150 +# Custom sidebar templates, maps document names to template names.
1.151 +#html_sidebars = {}
1.152 +
1.153 +# Additional templates that should be rendered to pages, maps page names to
1.154 +# template names.
1.155 +#html_additional_pages = {}
1.156 +
1.157 +# If false, no module index is generated.
1.158 +html_use_modindex = False
1.159 +
1.160 +# If false, no index is generated.
1.161 +#html_use_index = True
1.162 +
1.163 +# If true, the index is split into individual pages for each letter.
1.164 +#html_split_index = False
1.165 +
1.166 +# If true, the reST sources are included in the HTML build as _sources/<name>.
1.167 +#html_copy_source = True
1.168 +
1.169 +# If true, an OpenSearch description file will be output, and all pages will
1.170 +# contain a <link> tag referring to it. The value of this option must be the
1.171 +# base URL from which the finished HTML is served.
1.172 +#html_use_opensearch = ''
1.173 +
1.174 +# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
1.175 +#html_file_suffix = ''
1.176 +
1.177 +# Output file base name for HTML help builder.
1.178 +htmlhelp_basename = 'Mockdoc'
1.179 +
1.180 +
1.181 +# Options for LaTeX output
1.182 +# ------------------------
1.183 +
1.184 +# The paper size ('letter' or 'a4').
1.185 +#latex_paper_size = 'letter'
1.186 +
1.187 +# The font size ('10pt', '11pt' or '12pt').
1.188 +latex_font_size = '12pt'
1.189 +
1.190 +# Grouping the document tree into LaTeX files. List of tuples
1.191 +# (source start file, target name, title, author, document class [howto/manual]).
1.192 +latex_documents = [
1.193 + ('index', 'Mock.tex', u'Mock Documentation',
1.194 + u'Michael Foord', 'manual'),
1.195 +]
1.196 +
1.197 +# The name of an image file (relative to this directory) to place at the top of
1.198 +# the title page.
1.199 +#latex_logo = None
1.200 +
1.201 +# For "manual" documents, if this is true, then toplevel headings are parts,
1.202 +# not chapters.
1.203 +#latex_use_parts = False
1.204 +
1.205 +# Additional stuff for the LaTeX preamble.
1.206 +#latex_preamble = ''
1.207 +
1.208 +# Documents to append as an appendix to all manuals.
1.209 +#latex_appendices = []
1.210 +
1.211 +# If false, no module index is generated.
1.212 +latex_use_modindex = False
1.213 \ No newline at end of file
