1# -*- coding: utf-8 -*- 2# 3# Mock documentation build configuration file, created by 4# sphinx-quickstart on Mon Nov 17 18:12:00 2008. 5# 6# This file is execfile()d with the current directory set to its containing dir. 7# 8# The contents of this file are pickled, so don't put values in the namespace 9# that aren't pickleable (module imports are okay, they're removed automatically). 10# 11# All configuration values have a default value; values that are commented out 12# serve to show the default value. 13 14import sys, os 15sys.path.insert(0, os.path.abspath('..')) 16 17import mock 18 19# If your extensions are in another directory, add it here. If the directory 20# is relative to the documentation root, use os.path.abspath to make it 21# absolute, like shown here. 22#sys.path.append(os.path.abspath('some/directory')) 23 24# General configuration 25# --------------------- 26 27# Add any Sphinx extension module names here, as strings. They can be extensions 28# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. 29extensions = ['sphinx.ext.doctest'] 30 31doctest_global_setup = """ 32import os 33import sys 34import mock 35from mock import * # yeah, I know :-/ 36import __main__ 37 38if os.getcwd() not in sys.path: 39 sys.path.append(os.getcwd()) 40 41# keep a reference to __main__ 42sys.modules['__main'] = __main__ 43 44class ProxyModule(object): 45 def __init__(self): 46 self.__dict__ = globals() 47 48sys.modules['__main__'] = ProxyModule() 49""" 50 51doctest_global_cleanup = """ 52sys.modules['__main__'] = sys.modules['__main'] 53""" 54 55html_theme = 'nature' 56html_theme_options = {} 57 58# Add any paths that contain templates here, relative to this directory. 59#templates_path = ['_templates'] 60 61# The suffix of source filenames. 62source_suffix = '.txt' 63 64# The master toctree document. 65master_doc = 'index' 66 67# General substitutions. 68project = u'Mock' 69copyright = u'2007-2015, Michael Foord & the mock team' 70 71# The default replacements for |version| and |release|, also used in various 72# other places throughout the built documents. Supplied by pbr. 73# 74version = release = mock.mock.__version__ 75 76# There are two options for replacing |today|: either, you set today to some 77# non-false value, then it is used: (Set from pbr) 78today = '' 79# Else, today_fmt is used as the format for a strftime call. 80# today_fmt = '%B %d, %Y' 81 82# List of documents that shouldn't be included in the build. 83#unused_docs = [] 84 85# List of directories, relative to source directories, that shouldn't be searched 86# for source files. 87exclude_trees = [] 88 89# The reST default role (used for this markup: `text`) to use for all documents. 90#default_role = None 91 92# If true, '()' will be appended to :func: etc. cross-reference text. 93#add_function_parentheses = True 94 95# If true, the current module name will be prepended to all description 96# unit titles (such as .. function::). 97add_module_names = False 98 99# If true, sectionauthor and moduleauthor directives will be shown in the 100# output. They are ignored by default. 101#show_authors = False 102 103# The name of the Pygments (syntax highlighting) style to use. 104pygments_style = 'friendly' 105 106 107# Options for HTML output 108# ----------------------- 109 110# The style sheet to use for HTML and HTML Help pages. A file of that name 111# must exist either in Sphinx' static/ path, or in one of the custom paths 112# given in html_static_path. 113#html_style = 'adctheme.css' 114 115# The name for this set of Sphinx documents. If None, it defaults to 116# "<project> v<release> documentation". 117#html_title = None 118 119# A shorter title for the navigation bar. Default is the same as html_title. 120#html_short_title = None 121 122# The name of an image file (relative to this directory) to place at the top 123# of the sidebar. 124#html_logo = None 125 126# The name of an image file (within the static path) to use as favicon of the 127# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 128# pixels large. 129#html_favicon = None 130 131# Add any paths that contain custom static files (such as style sheets) here, 132# relative to this directory. They are copied after the builtin static files, 133# so a file named "default.css" will overwrite the builtin "default.css". 134#html_static_path = ['_static'] 135 136# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, 137# using the given strftime format. 138html_last_updated_fmt = '%b %d, %Y' 139 140# If true, SmartyPants will be used to convert quotes and dashes to 141# typographically correct entities. 142#html_use_smartypants = True 143 144# Custom sidebar templates, maps document names to template names. 145#html_sidebars = {} 146 147# Additional templates that should be rendered to pages, maps page names to 148# template names. 149#html_additional_pages = {} 150 151# If false, no module index is generated. 152html_use_modindex = False 153 154# If false, no index is generated. 155#html_use_index = True 156 157# If true, the index is split into individual pages for each letter. 158#html_split_index = False 159 160# If true, the reST sources are included in the HTML build as _sources/<name>. 161#html_copy_source = True 162 163# If true, an OpenSearch description file will be output, and all pages will 164# contain a <link> tag referring to it. The value of this option must be the 165# base URL from which the finished HTML is served. 166#html_use_opensearch = '' 167 168# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). 169#html_file_suffix = '' 170 171# Output file base name for HTML help builder. 172htmlhelp_basename = 'Mockdoc' 173 174 175# Options for LaTeX output 176# ------------------------ 177 178# The paper size ('letter' or 'a4'). 179#latex_paper_size = 'letter' 180 181# The font size ('10pt', '11pt' or '12pt'). 182latex_font_size = '12pt' 183 184# Grouping the document tree into LaTeX files. List of tuples 185# (source start file, target name, title, author, document class [howto/manual]). 186latex_documents = [ 187 ('index', 'Mock.tex', u'Mock Documentation', 188 u'Michael Foord', 'manual'), 189] 190 191# The name of an image file (relative to this directory) to place at the top of 192# the title page. 193#latex_logo = None 194 195# For "manual" documents, if this is true, then toplevel headings are parts, 196# not chapters. 197#latex_use_parts = False 198 199# Additional stuff for the LaTeX preamble. 200#latex_preamble = '' 201 202# Documents to append as an appendix to all manuals. 203#latex_appendices = [] 204 205# If false, no module index is generated. 206latex_use_modindex = False 207