17
17
18
18
from mock import Mock as MagicMock
19
19
20
+
20
21
class Mock (MagicMock ):
21
22
__all__ = []
22
23
23
24
@classmethod
24
25
def __getattr__ (cls , name ):
25
- return Mock ()
26
-
27
- MOCK_MODULES = ['argparse' , 'numpy' , 'pandas' ]
26
+ return Mock ()
27
+
28
+
29
+ MOCK_MODULES = ["argparse" , "numpy" , "pandas" ]
28
30
sys .modules .update ((mod_name , Mock ()) for mod_name in MOCK_MODULES )
29
31
30
32
# workaround for building docs without numpy
31
33
import numpy
34
+
32
35
numpy .frombuffer = lambda x , dtype : [None ]
33
36
numpy .ndarray = Mock
34
37
# end-of-workaround
35
38
36
39
# If extensions (or modules to document with autodoc) are in another directory,
37
40
# add these directories to sys.path here. If the directory is relative to the
38
41
# documentation root, use os.path.abspath to make it absolute, like shown here.
39
- sys .path .insert (0 , os .path .abspath (' ../..' ))
42
+ sys .path .insert (0 , os .path .abspath (" ../.." ))
40
43
41
44
# -- General configuration ------------------------------------------------
42
45
43
46
# If your documentation needs a minimal Sphinx version, state it here.
44
- #needs_sphinx = '1.0'
47
+ # needs_sphinx = '1.0'
45
48
46
49
# Add any Sphinx extension module names here, as strings. They can be
47
50
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
48
51
# ones.
49
52
extensions = [
50
- ' sphinx.ext.autodoc' ,
53
+ " sphinx.ext.autodoc" ,
51
54
]
52
55
53
56
# Add any paths that contain templates here, relative to this directory.
54
- templates_path = [' _templates' ]
57
+ templates_path = [" _templates" ]
55
58
56
59
# The suffix of source filenames.
57
- source_suffix = ' .rst'
60
+ source_suffix = " .rst"
58
61
59
62
# The encoding of source files.
60
- #source_encoding = 'utf-8-sig'
63
+ # source_encoding = 'utf-8-sig'
61
64
62
65
# The master toctree document.
63
- master_doc = ' index'
66
+ master_doc = " index"
64
67
65
68
# General information about the project.
66
- project = u' qPython'
67
- copyright = u' 2014-2016, DEVnet'
69
+ project = u" qPython"
70
+ copyright = u" 2014-2016, DEVnet"
68
71
69
72
# The version info for the project you're documenting, acts as replacement for
70
73
# |version| and |release|, also used in various other places throughout the
71
74
# built documents.
72
75
#
73
76
from qpython import __version__
77
+
74
78
# The short X.Y version.
75
79
version = __version__
76
80
# The full version, including alpha/beta/rc tags.
77
81
release = __version__
78
82
79
83
# The language for content autogenerated by Sphinx. Refer to documentation
80
84
# for a list of supported languages.
81
- #language = None
85
+ # language = None
82
86
83
87
# There are two options for replacing |today|: either, you set today to some
84
88
# non-false value, then it is used:
85
- #today = ''
89
+ # today = ''
86
90
# Else, today_fmt is used as the format for a strftime call.
87
- #today_fmt = '%B %d, %Y'
91
+ # today_fmt = '%B %d, %Y'
88
92
89
93
# List of patterns, relative to source directory, that match files and
90
94
# directories to ignore when looking for source files.
91
95
exclude_patterns = []
92
96
93
97
# The reST default role (used for this markup: `text`) to use for all
94
98
# documents.
95
- #default_role = None
99
+ # default_role = None
96
100
97
101
# If true, '()' will be appended to :func: etc. cross-reference text.
98
- #add_function_parentheses = True
102
+ # add_function_parentheses = True
99
103
100
104
# If true, the current module name will be prepended to all description
101
105
# unit titles (such as .. function::).
102
- #add_module_names = True
106
+ # add_module_names = True
103
107
104
108
# If true, sectionauthor and moduleauthor directives will be shown in the
105
109
# output. They are ignored by default.
106
- #show_authors = False
110
+ # show_authors = False
107
111
108
112
# The name of the Pygments (syntax highlighting) style to use.
109
- pygments_style = ' sphinx'
113
+ pygments_style = " sphinx"
110
114
111
115
# A list of ignored prefixes for module index sorting.
112
- #modindex_common_prefix = []
116
+ # modindex_common_prefix = []
113
117
114
118
# If true, keep warnings as "system message" paragraphs in the built documents.
115
- #keep_warnings = False
119
+ # keep_warnings = False
116
120
117
121
118
122
# -- Options for HTML output ----------------------------------------------
119
123
120
124
# The theme to use for HTML and HTML Help pages. See the documentation for
121
125
# a list of builtin themes.
122
- html_theme = ' default'
126
+ html_theme = " default"
123
127
124
128
# Theme options are theme-specific and customize the look and feel of a theme
125
129
# further. For a list of options available for each theme, see the
126
130
# documentation.
127
- #html_theme_options = {}
131
+ # html_theme_options = {}
128
132
129
133
# Add any paths that contain custom themes here, relative to this directory.
130
- #html_theme_path = []
134
+ # html_theme_path = []
131
135
132
136
# The name for this set of Sphinx documents. If None, it defaults to
133
137
# "<project> v<release> documentation".
134
- #html_title = None
138
+ # html_title = None
135
139
136
140
# A shorter title for the navigation bar. Default is the same as html_title.
137
- #html_short_title = None
141
+ # html_short_title = None
138
142
139
143
# The name of an image file (relative to this directory) to place at the top
140
144
# of the sidebar.
141
- #html_logo = None
145
+ # html_logo = None
142
146
143
147
# The name of an image file (within the static path) to use as favicon of the
144
148
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
145
149
# pixels large.
146
- #html_favicon = None
150
+ # html_favicon = None
147
151
148
152
# Add any paths that contain custom static files (such as style sheets) here,
149
153
# relative to this directory. They are copied after the builtin static files,
150
154
# so a file named "default.css" will overwrite the builtin "default.css".
151
- #html_static_path = ['_static']
155
+ # html_static_path = ['_static']
152
156
153
157
# Add any extra paths that contain custom files (such as robots.txt or
154
158
# .htaccess) here, relative to this directory. These files are copied
155
159
# directly to the root of the documentation.
156
- #html_extra_path = []
160
+ # html_extra_path = []
157
161
158
162
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
159
163
# using the given strftime format.
160
- #html_last_updated_fmt = '%b %d, %Y'
164
+ # html_last_updated_fmt = '%b %d, %Y'
161
165
162
166
# If true, SmartyPants will be used to convert quotes and dashes to
163
167
# typographically correct entities.
164
- #html_use_smartypants = True
168
+ # html_use_smartypants = True
165
169
166
170
# Custom sidebar templates, maps document names to template names.
167
- #html_sidebars = {}
171
+ # html_sidebars = {}
168
172
169
173
# Additional templates that should be rendered to pages, maps page names to
170
174
# template names.
171
- #html_additional_pages = {}
175
+ # html_additional_pages = {}
172
176
173
177
# If false, no module index is generated.
174
- #html_domain_indices = True
178
+ # html_domain_indices = True
175
179
176
180
# If false, no index is generated.
177
- #html_use_index = True
181
+ # html_use_index = True
178
182
179
183
# If true, the index is split into individual pages for each letter.
180
- #html_split_index = False
184
+ # html_split_index = False
181
185
182
186
# If true, links to the reST sources are added to the pages.
183
- #html_show_sourcelink = True
187
+ # html_show_sourcelink = True
184
188
185
189
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
186
- #html_show_sphinx = True
190
+ # html_show_sphinx = True
187
191
188
192
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
189
- #html_show_copyright = True
193
+ # html_show_copyright = True
190
194
191
195
# If true, an OpenSearch description file will be output, and all pages will
192
196
# contain a <link> tag referring to it. The value of this option must be the
193
197
# base URL from which the finished HTML is served.
194
- #html_use_opensearch = ''
198
+ # html_use_opensearch = ''
195
199
196
200
# This is the file name suffix for HTML files (e.g. ".xhtml").
197
- #html_file_suffix = None
201
+ # html_file_suffix = None
198
202
199
203
# Output file base name for HTML help builder.
200
- htmlhelp_basename = ' qPythondoc'
204
+ htmlhelp_basename = " qPythondoc"
201
205
202
206
203
207
# -- Options for LaTeX output ---------------------------------------------
204
208
205
209
latex_elements = {
206
- # The paper size ('letterpaper' or 'a4paper').
207
- #'papersize': 'letterpaper',
208
-
209
- # The font size ('10pt', '11pt' or '12pt').
210
- #'pointsize': '10pt',
211
-
212
- # Additional stuff for the LaTeX preamble.
213
- #'preamble': '',
210
+ # The paper size ('letterpaper' or 'a4paper').
211
+ #'papersize': 'letterpaper',
212
+ # The font size ('10pt', '11pt' or '12pt').
213
+ #'pointsize': '10pt',
214
+ # Additional stuff for the LaTeX preamble.
215
+ #'preamble': '',
214
216
}
215
217
216
218
# Grouping the document tree into LaTeX files. List of tuples
217
219
# (source start file, target name, title,
218
220
# author, documentclass [howto, manual, or own class]).
219
221
latex_documents = [
220
- ('index' , 'qPython.tex' , u'qPython Documentation' ,
221
- u'DEVnet' , 'manual' ),
222
+ ("index" , "qPython.tex" , u"qPython Documentation" , u"DEVnet" , "manual" ),
222
223
]
223
224
224
225
# The name of an image file (relative to this directory) to place at the top of
225
226
# the title page.
226
- #latex_logo = None
227
+ # latex_logo = None
227
228
228
229
# For "manual" documents, if this is true, then toplevel headings are parts,
229
230
# not chapters.
230
- #latex_use_parts = False
231
+ # latex_use_parts = False
231
232
232
233
# If true, show page references after internal links.
233
- #latex_show_pagerefs = False
234
+ # latex_show_pagerefs = False
234
235
235
236
# If true, show URL addresses after external links.
236
- #latex_show_urls = False
237
+ # latex_show_urls = False
237
238
238
239
# Documents to append as an appendix to all manuals.
239
- #latex_appendices = []
240
+ # latex_appendices = []
240
241
241
242
# If false, no module index is generated.
242
- #latex_domain_indices = True
243
+ # latex_domain_indices = True
243
244
244
245
245
246
# -- Options for manual page output ---------------------------------------
246
247
247
248
# One entry per manual page. List of tuples
248
249
# (source start file, name, description, authors, manual section).
249
- man_pages = [
250
- ('index' , 'qpython' , u'qPython Documentation' ,
251
- [u'DEVnet' ], 1 )
252
- ]
250
+ man_pages = [("index" , "qpython" , u"qPython Documentation" , [u"DEVnet" ], 1 )]
253
251
254
252
# If true, show URL addresses after external links.
255
- #man_show_urls = False
253
+ # man_show_urls = False
256
254
257
255
258
256
# -- Options for Texinfo output -------------------------------------------
@@ -261,20 +259,26 @@ def __getattr__(cls, name):
261
259
# (source start file, target name, title, author,
262
260
# dir menu entry, description, category)
263
261
texinfo_documents = [
264
- ('index' , 'qPython' , u'qPython Documentation' ,
265
- u'DEVnet' , 'qPython' , 'Interprocess communication between Python and kdb+' ,
266
- 'Miscellaneous' ),
262
+ (
263
+ "index" ,
264
+ "qPython" ,
265
+ u"qPython Documentation" ,
266
+ u"DEVnet" ,
267
+ "qPython" ,
268
+ "Interprocess communication between Python and kdb+" ,
269
+ "Miscellaneous" ,
270
+ ),
267
271
]
268
272
269
273
# Documents to append as an appendix to all manuals.
270
- #texinfo_appendices = []
274
+ # texinfo_appendices = []
271
275
272
276
# If false, no module index is generated.
273
- #texinfo_domain_indices = True
277
+ # texinfo_domain_indices = True
274
278
275
279
# How to display URL addresses: 'footnote', 'no', or 'inline'.
276
- #texinfo_show_urls = 'footnote'
280
+ # texinfo_show_urls = 'footnote'
277
281
278
282
# If true, do not generate a @detailmenu in the "Top" node's menu.
279
- #texinfo_no_detailmenu = False
280
- autodoc_member_order = ' bysource'
283
+ # texinfo_no_detailmenu = False
284
+ autodoc_member_order = " bysource"
0 commit comments