Mock.__call__()   A
last analyzed

Complexity

Conditions 1

Size

Total Lines 2

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
dl 0
loc 2
rs 10
c 0
b 0
f 0
1
# -*- coding: utf-8 -*-
2
#
3
# cookiecutter documentation build configuration file, created by
4
# sphinx-quickstart on Thu Jul 11 11:31:49 2013.
5
#
6
# This file is execfile()d with the current directory set to its containing dir.
7
#
8
# Note that not all possible configuration values are present in this
9
# autogenerated file.
10
#
11
# All configuration values have a default; values that are commented out
12
# serve to show the default.
13
14
import sys, os
15
16
# If extensions (or modules to document with autodoc) are in another directory,
17
# add these directories to sys.path here. If the directory is relative to the
18
# documentation root, use os.path.abspath to make it absolute, like shown here.
19
#sys.path.insert(0, os.path.abspath('.'))
20
21
# For building docs in foreign environments where we don't have all our
22
# dependencies (like readthedocs), mock out imports that cause sphinx to fail.
23
# see: https://docs.readthedocs.io/en/latest/faq.html#i-get-import-errors-on-libraries-that-depend-on-c-modules
24
25
import sys
26
27
class Mock(object):
28
    def __init__(self, *args, **kwargs):
29
        pass
30
31
    def __call__(self, *args, **kwargs):
32
        return Mock()
33
34
    @classmethod
35
    def __getattr__(cls, name):
36
        if name in ('__file__', '__path__'):
37
            return '/dev/null'
38
        elif name[0] == name[0].upper():
39
            mockType = type(name, (), {})
40
            mockType.__module__ = __name__
41
            return mockType
42
        else:
43
            return Mock()
44
45
MOCK_MODULES = ['yaml']
46
for mod_name in MOCK_MODULES:
47
    sys.modules[mod_name] = Mock()
48
49
50
# Add parent dir to path
51
cwd = os.getcwd()
52
parent = os.path.dirname(cwd)
53
sys.path.append(parent)
54
55
import cookiecutter
56
57
# -- General configuration -----------------------------------------------------
58
59
# If your documentation needs a minimal Sphinx version, state it here.
60
#needs_sphinx = '1.0'
61
62
# Add any Sphinx extension module names here, as strings. They can be extensions
63
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
64
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.intersphinx',
65
              'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.imgmath',
66
              'sphinx.ext.ifconfig', 'sphinx.ext.viewcode', 'docs.ccext']
67
68
# Add any paths that contain templates here, relative to this directory.
69
templates_path = ['_templates']
70
71
# The suffix of source filenames.
72
source_suffix = '.rst'
73
74
# The encoding of source files.
75
#source_encoding = 'utf-8-sig'
76
77
# The master toctree document.
78
master_doc = 'index'
79
80
# General information about the project.
81
project = u'cookiecutter'
82
copyright = u'2013-2016, Audrey Roy'
83
84
# The version info for the project you're documenting, acts as replacement for
85
# |version| and |release|, also used in various other places throughout the
86
# built documents.
87
#
88
# The short X.Y version.
89
version = cookiecutter.__version__
90
# The full version, including alpha/beta/rc tags.
91
release = cookiecutter.__version__
92
93
# The language for content autogenerated by Sphinx. Refer to documentation
94
# for a list of supported languages.
95
#language = None
96
97
# There are two options for replacing |today|: either, you set today to some
98
# non-false value, then it is used:
99
#today = ''
100
# Else, today_fmt is used as the format for a strftime call.
101
#today_fmt = '%B %d, %Y'
102
103
# List of patterns, relative to source directory, that match files and
104
# directories to ignore when looking for source files.
105
exclude_patterns = ['_build']
106
107
# The reST default role (used for this markup: `text`) to use for all documents.
108
#default_role = None
109
110
# If true, '()' will be appended to :func: etc. cross-reference text.
111
#add_function_parentheses = True
112
113
# If true, the current module name will be prepended to all description
114
# unit titles (such as .. function::).
115
#add_module_names = True
116
117
# If true, sectionauthor and moduleauthor directives will be shown in the
118
# output. They are ignored by default.
119
#show_authors = False
120
121
# The name of the Pygments (syntax highlighting) style to use.
122
pygments_style = 'sphinx'
123
124
# A list of ignored prefixes for module index sorting.
125
#modindex_common_prefix = []
126
127
# If true, keep warnings as "system message" paragraphs in the built documents.
128
#keep_warnings = False
129
130
# Suppress nonlocal image warnings
131
suppress_warnings = ['image.nonlocal_uri']
132
133
# -- Options for HTML output ---------------------------------------------------
134
135
# The theme to use for HTML and HTML Help pages.  See the documentation for
136
# a list of builtin themes.
137
html_theme = 'sphinx_rtd_theme'
138
139
# Theme options are theme-specific and customize the look and feel of a theme
140
# further.  For a list of options available for each theme, see the
141
# documentation.
142
#html_theme_options = {}
143
144
# Add any paths that contain custom themes here, relative to this directory.
145
#html_theme_path = []
146
147
# The name for this set of Sphinx documents.  If None, it defaults to
148
# "<project> v<release> documentation".
149
#html_title = None
150
151
# A shorter title for the navigation bar.  Default is the same as html_title.
152
#html_short_title = None
153
154
# The name of an image file (relative to this directory) to place at the top
155
# of the sidebar.
156
#html_logo = None
157
158
# The name of an image file (within the static path) to use as favicon of the
159
# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
160
# pixels large.
161
#html_favicon = None
162
163
# Add any paths that contain custom static files (such as style sheets) here,
164
# relative to this directory. They are copied after the builtin static files,
165
# so a file named "default.css" will overwrite the builtin "default.css".
166
html_static_path = []
167
168
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
169
# using the given strftime format.
170
#html_last_updated_fmt = '%b %d, %Y'
171
172
# If true, SmartyPants will be used to convert quotes and dashes to
173
# typographically correct entities.
174
#html_use_smartypants = True
175
176
# Custom sidebar templates, maps document names to template names.
177
#html_sidebars = {}
178
179
# Additional templates that should be rendered to pages, maps page names to
180
# template names.
181
#html_additional_pages = {}
182
183
# If false, no module index is generated.
184
#html_domain_indices = True
185
186
# If false, no index is generated.
187
#html_use_index = True
188
189
# If true, the index is split into individual pages for each letter.
190
#html_split_index = False
191
192
# If true, links to the reST sources are added to the pages.
193
#html_show_sourcelink = True
194
195
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
196
#html_show_sphinx = True
197
198
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
199
#html_show_copyright = True
200
201
# If true, an OpenSearch description file will be output, and all pages will
202
# contain a <link> tag referring to it.  The value of this option must be the
203
# base URL from which the finished HTML is served.
204
#html_use_opensearch = ''
205
206
# This is the file name suffix for HTML files (e.g. ".xhtml").
207
#html_file_suffix = None
208
209
# Output file base name for HTML help builder.
210
htmlhelp_basename = 'cookiecutterdoc'
211
212
213
# -- Options for LaTeX output --------------------------------------------------
214
215
latex_elements = {
216
# The paper size ('letterpaper' or 'a4paper').
217
#'papersize': 'letterpaper',
218
219
# The font size ('10pt', '11pt' or '12pt').
220
#'pointsize': '10pt',
221
222
# Additional stuff for the LaTeX preamble.
223
#'preamble': '',
224
}
225
226
# Grouping the document tree into LaTeX files. List of tuples
227
# (source start file, target name, title, author, documentclass [howto/manual]).
228
latex_documents = [
229
  ('index', 'cookiecutter.tex', u'cookiecutter Documentation',
230
   u'Audrey Roy', 'manual'),
231
]
232
233
# The name of an image file (relative to this directory) to place at the top of
234
# the title page.
235
#latex_logo = None
236
237
# For "manual" documents, if this is true, then toplevel headings are parts,
238
# not chapters.
239
#latex_use_parts = False
240
241
# If true, show page references after internal links.
242
#latex_show_pagerefs = False
243
244
# If true, show URL addresses after external links.
245
#latex_show_urls = False
246
247
# Documents to append as an appendix to all manuals.
248
#latex_appendices = []
249
250
# If false, no module index is generated.
251
#latex_domain_indices = True
252
253
254
# -- Options for manual page output --------------------------------------------
255
256
# One entry per manual page. List of tuples
257
# (source start file, name, description, authors, manual section).
258
man_pages = [
259
    ('index', 'cookiecutter', u'cookiecutter Documentation',
260
     [u'Audrey Roy'], 1)
261
]
262
263
# If true, show URL addresses after external links.
264
#man_show_urls = False
265
266
267
# -- Options for Texinfo output ------------------------------------------------
268
269
# Grouping the document tree into Texinfo files. List of tuples
270
# (source start file, target name, title, author,
271
#  dir menu entry, description, category)
272
texinfo_documents = [
273
  ('index', 'cookiecutter', u'cookiecutter Documentation',
274
   u'Audrey Roy', 'cookiecutter', 'One line description of project.',
275
   'Miscellaneous'),
276
]
277
278
# Documents to append as an appendix to all manuals.
279
#texinfo_appendices = []
280
281
# If false, no module index is generated.
282
#texinfo_domain_indices = True
283
284
# How to display URL addresses: 'footnote', 'no', or 'inline'.
285
#texinfo_show_urls = 'footnote'
286
287
# If true, do not generate a @detailmenu in the "Top" node's menu.
288
#texinfo_no_detailmenu = False
289
290
291
# -- Options for Epub output ---------------------------------------------------
292
293
# Bibliographic Dublin Core info.
294
epub_title = u'cookiecutter'
295
epub_author = u'Audrey Roy'
296
epub_publisher = u'Audrey Roy'
297
epub_copyright = u'2013-2016, Audrey Roy'
298
299
# The language of the text. It defaults to the language option
300
# or en if the language is not set.
301
#epub_language = ''
302
303
# The scheme of the identifier. Typical schemes are ISBN or URL.
304
#epub_scheme = ''
305
306
# The unique identifier of the text. This can be a ISBN number
307
# or the project homepage.
308
#epub_identifier = ''
309
310
# A unique identification for the text.
311
#epub_uid = ''
312
313
# A tuple containing the cover image and cover page html template filenames.
314
#epub_cover = ()
315
316
# A sequence of (type, uri, title) tuples for the guide element of content.opf.
317
#epub_guide = ()
318
319
# HTML files that should be inserted before the pages created by sphinx.
320
# The format is a list of tuples containing the path and title.
321
#epub_pre_files = []
322
323
# HTML files shat should be inserted after the pages created by sphinx.
324
# The format is a list of tuples containing the path and title.
325
#epub_post_files = []
326
327
# A list of files that should not be packed into the epub file.
328
#epub_exclude_files = []
329
330
# The depth of the table of contents in toc.ncx.
331
#epub_tocdepth = 3
332
333
# Allow duplicate toc entries.
334
#epub_tocdup = True
335
336
# Fix unsupported image types using the PIL.
337
#epub_fix_images = False
338
339
# Scale large images.
340
#epub_max_image_width = 0
341
342
# If 'no', URL addresses will not be shown.
343
#epub_show_urls = 'inline'
344
345
# If false, no index is generated.
346
#epub_use_index = True
347
348
349
# Example configuration for intersphinx: refer to the Python standard library.
350
intersphinx_mapping = {'http://docs.python.org/': None}
351