1
+
2
+
3
+
4
+
5
+ <!doctype html>
6
+ < html lang ="en " class ="no-js ">
7
+ < head >
8
+
9
+ < meta charset ="utf-8 ">
10
+ < meta name ="viewport " content ="width=device-width,initial-scale=1 ">
11
+ < meta http-equiv ="x-ua-compatible " content ="ie=edge ">
12
+
13
+ < meta name ="description " content ="Automatic documentation from docstrings, for mkdocs. ">
14
+
15
+
16
+
17
+
18
+ < meta name ="lang:clipboard.copy " content ="Copy to clipboard ">
19
+
20
+ < meta name ="lang:clipboard.copied " content ="Copied to clipboard ">
21
+
22
+ < meta name ="lang:search.language " content ="en ">
23
+
24
+ < meta name ="lang:search.pipeline.stopwords " content ="True ">
25
+
26
+ < meta name ="lang:search.pipeline.trimmer " content ="True ">
27
+
28
+ < meta name ="lang:search.result.none " content ="No matching documents ">
29
+
30
+ < meta name ="lang:search.result.one " content ="1 matching document ">
31
+
32
+ < meta name ="lang:search.result.other " content ="# matching documents ">
33
+
34
+ < meta name ="lang:search.tokenizer " content ="[\s\-]+ ">
35
+
36
+ < link rel ="shortcut icon " href ="/assets/images/favicon.png ">
37
+ < meta name ="generator " content ="mkdocs-1.0.4, mkdocs-material-4.6.0 ">
38
+
39
+
40
+
41
+ < title > mkdocstrings</ title >
42
+
43
+
44
+
45
+ < link rel ="stylesheet " href ="/assets/stylesheets/application.1b62728e.css ">
46
+
47
+
48
+
49
+
50
+ < script src ="/assets/javascripts/modernizr.268332fc.js "> </ script >
51
+
52
+
53
+
54
+ < link href ="https://fonts.gstatic.com " rel ="preconnect " crossorigin >
55
+ < link rel ="stylesheet " href ="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback ">
56
+ < style > body , input {font-family : "Roboto" , "Helvetica Neue" , Helvetica, Arial, sans-serif}code , kbd , pre {font-family : "Roboto Mono" , "Courier New" , Courier, monospace}</ style >
57
+
58
+
59
+ < link rel ="stylesheet " href ="/assets/fonts/material-icons.css ">
60
+
61
+
62
+ < link rel ="stylesheet " href ="/custom.css ">
63
+
64
+
65
+
66
+
67
+
68
+ </ head >
69
+
70
+ < body dir ="ltr ">
71
+
72
+ < svg class ="md-svg ">
73
+ < defs >
74
+
75
+
76
+ < svg xmlns ="http://www.w3.org/2000/svg " width ="416 " height ="448 " viewBox ="0 0 416 448 " id ="__github "> < path fill ="currentColor " d ="M160 304q0 10-3.125 20.5t-10.75 19T128 352t-18.125-8.5-10.75-19T96 304t3.125-20.5 10.75-19T128 256t18.125 8.5 10.75 19T160 304zm160 0q0 10-3.125 20.5t-10.75 19T288 352t-18.125-8.5-10.75-19T256 304t3.125-20.5 10.75-19T288 256t18.125 8.5 10.75 19T320 304zm40 0q0-30-17.25-51T296 232q-10.25 0-48.75 5.25Q229.5 240 208 240t-39.25-2.75Q130.75 232 120 232q-29.5 0-46.75 21T56 304q0 22 8 38.375t20.25 25.75 30.5 15 35 7.375 37.25 1.75h42q20.5 0 37.25-1.75t35-7.375 30.5-15 20.25-25.75T360 304zm56-44q0 51.75-15.25 82.75-9.5 19.25-26.375 33.25t-35.25 21.5-42.5 11.875-42.875 5.5T212 416q-19.5 0-35.5-.75t-36.875-3.125-38.125-7.5-34.25-12.875T37 371.5t-21.5-28.75Q0 312 0 260q0-59.25 34-99-6.75-20.5-6.75-42.5 0-29 12.75-54.5 27 0 47.5 9.875t47.25 30.875Q171.5 96 212 96q37 0 70 8 26.25-20.5 46.75-30.25T376 64q12.75 25.5 12.75 54.5 0 21.75-6.75 42 34 40 34 99.5z "/> </ svg >
77
+
78
+ </ defs >
79
+ </ svg >
80
+ < input class ="md-toggle " data-md-toggle ="drawer " type ="checkbox " id ="__drawer " autocomplete ="off ">
81
+ < input class ="md-toggle " data-md-toggle ="search " type ="checkbox " id ="__search " autocomplete ="off ">
82
+ < label class ="md-overlay " data-md-component ="overlay " for ="__drawer "> </ label >
83
+
84
+
85
+ < header class ="md-header " data-md-component ="header ">
86
+ < nav class ="md-header-nav md-grid ">
87
+ < div class ="md-flex ">
88
+ < div class ="md-flex__cell md-flex__cell--shrink ">
89
+ < a href ="https://mkdocstrings.github.io/ " title ="mkdocstrings " class ="md-header-nav__button md-logo ">
90
+
91
+ < i class ="md-icon "> </ i >
92
+
93
+ </ a >
94
+ </ div >
95
+ < div class ="md-flex__cell md-flex__cell--shrink ">
96
+ < label class ="md-icon md-icon--menu md-header-nav__button " for ="__drawer "> </ label >
97
+ </ div >
98
+ < div class ="md-flex__cell md-flex__cell--stretch ">
99
+ < div class ="md-flex__ellipsis md-header-nav__title " data-md-component ="title ">
100
+
101
+ < span class ="md-header-nav__topic ">
102
+ mkdocstrings
103
+ </ span >
104
+ < span class ="md-header-nav__topic ">
105
+
106
+
107
+
108
+ </ span >
109
+
110
+ </ div >
111
+ </ div >
112
+ < div class ="md-flex__cell md-flex__cell--shrink ">
113
+
114
+ < label class ="md-icon md-icon--search md-header-nav__button " for ="__search "> </ label >
115
+
116
+ < div class ="md-search " data-md-component ="search " role ="dialog ">
117
+ < label class ="md-search__overlay " for ="__search "> </ label >
118
+ < div class ="md-search__inner " role ="search ">
119
+ < form class ="md-search__form " name ="search ">
120
+ < input type ="text " class ="md-search__input " name ="query " placeholder ="Search " autocapitalize ="off " autocorrect ="off " autocomplete ="off " spellcheck ="false " data-md-component ="query " data-md-state ="active ">
121
+ < label class ="md-icon md-search__icon " for ="__search "> </ label >
122
+ < button type ="reset " class ="md-icon md-search__icon " data-md-component ="reset " tabindex ="-1 ">
123
+ 
124
+ </ button >
125
+ </ form >
126
+ < div class ="md-search__output ">
127
+ < div class ="md-search__scrollwrap " data-md-scrollfix >
128
+ < div class ="md-search-result " data-md-component ="result ">
129
+ < div class ="md-search-result__meta ">
130
+ Type to start searching
131
+ </ div >
132
+ < ol class ="md-search-result__list "> </ ol >
133
+ </ div >
134
+ </ div >
135
+ </ div >
136
+ </ div >
137
+ </ div >
138
+
139
+ </ div >
140
+
141
+ < div class ="md-flex__cell md-flex__cell--shrink ">
142
+ < div class ="md-header-nav__source ">
143
+
144
+
145
+
146
+
147
+
148
+ < a href ="https://github.com/pawamoy/mkdocstrings/ " title ="Go to repository " class ="md-source " data-md-source ="github ">
149
+
150
+ < div class ="md-source__icon ">
151
+ < svg viewBox ="0 0 24 24 " width ="24 " height ="24 ">
152
+ < use xlink:href ="#__github " width ="24 " height ="24 "> </ use >
153
+ </ svg >
154
+ </ div >
155
+
156
+ < div class ="md-source__repository ">
157
+ pawamoy/mkdocstrings
158
+ </ div >
159
+ </ a >
160
+ </ div >
161
+ </ div >
162
+
163
+ </ div >
164
+ </ nav >
165
+ </ header >
166
+
167
+ < div class ="md-container ">
168
+
169
+
170
+
171
+
172
+ < main class ="md-main " role ="main ">
173
+ < div class ="md-main__inner md-grid " data-md-component ="container ">
174
+
175
+
176
+ < div class ="md-sidebar md-sidebar--primary " data-md-component ="navigation ">
177
+ < div class ="md-sidebar__scrollwrap ">
178
+ < div class ="md-sidebar__inner ">
179
+ < nav class ="md-nav md-nav--primary " data-md-level ="0 ">
180
+ < label class ="md-nav__title md-nav__title--site " for ="__drawer ">
181
+ < a href ="https://mkdocstrings.github.io/ " title ="mkdocstrings " class ="md-nav__button md-logo ">
182
+
183
+ < i class ="md-icon "> </ i >
184
+
185
+ </ a >
186
+ mkdocstrings
187
+ </ label >
188
+
189
+ < div class ="md-nav__source ">
190
+
191
+
192
+
193
+
194
+
195
+ < a href ="https://github.com/pawamoy/mkdocstrings/ " title ="Go to repository " class ="md-source " data-md-source ="github ">
196
+
197
+ < div class ="md-source__icon ">
198
+ < svg viewBox ="0 0 24 24 " width ="24 " height ="24 ">
199
+ < use xlink:href ="#__github " width ="24 " height ="24 "> </ use >
200
+ </ svg >
201
+ </ div >
202
+
203
+ < div class ="md-source__repository ">
204
+ pawamoy/mkdocstrings
205
+ </ div >
206
+ </ a >
207
+ </ div >
208
+
209
+ < ul class ="md-nav__list " data-md-scrollfix >
210
+
211
+
212
+
213
+
214
+
215
+
216
+ < li class ="md-nav__item ">
217
+ < a href ="/. " title ="Overview " class ="md-nav__link ">
218
+ Overview
219
+ </ a >
220
+ </ li >
221
+
222
+
223
+
224
+
225
+
226
+
227
+
228
+ < li class ="md-nav__item md-nav__item--nested ">
229
+
230
+ < input class ="md-toggle md-nav__toggle " data-md-toggle ="nav-2 " type ="checkbox " id ="nav-2 ">
231
+
232
+ < label class ="md-nav__link " for ="nav-2 ">
233
+ Reference
234
+ </ label >
235
+ < nav class ="md-nav " data-md-component ="collapsible " data-md-level ="1 ">
236
+ < label class ="md-nav__title " for ="nav-2 ">
237
+ Reference
238
+ </ label >
239
+ < ul class ="md-nav__list " data-md-scrollfix >
240
+
241
+
242
+
243
+
244
+
245
+
246
+
247
+ < li class ="md-nav__item ">
248
+ < a href ="/reference/plugin/ " title ="plugin.py " class ="md-nav__link ">
249
+ plugin.py
250
+ </ a >
251
+ </ li >
252
+
253
+
254
+
255
+
256
+
257
+
258
+
259
+ < li class ="md-nav__item ">
260
+ < a href ="/reference/documenter/ " title ="documenter.py " class ="md-nav__link ">
261
+ documenter.py
262
+ </ a >
263
+ </ li >
264
+
265
+
266
+ </ ul >
267
+ </ nav >
268
+ </ li >
269
+
270
+
271
+
272
+
273
+
274
+
275
+
276
+ < li class ="md-nav__item ">
277
+ < a href ="/contributing/ " title ="Contributing " class ="md-nav__link ">
278
+ Contributing
279
+ </ a >
280
+ </ li >
281
+
282
+
283
+
284
+
285
+
286
+
287
+
288
+ < li class ="md-nav__item ">
289
+ < a href ="/code_of_conduct/ " title ="Code of Conduct " class ="md-nav__link ">
290
+ Code of Conduct
291
+ </ a >
292
+ </ li >
293
+
294
+
295
+
296
+
297
+
298
+
299
+
300
+ < li class ="md-nav__item ">
301
+ < a href ="/changelog/ " title ="Changelog " class ="md-nav__link ">
302
+ Changelog
303
+ </ a >
304
+ </ li >
305
+
306
+
307
+
308
+
309
+
310
+
311
+
312
+ < li class ="md-nav__item ">
313
+ < a href ="/credits/ " title ="Credits " class ="md-nav__link ">
314
+ Credits
315
+ </ a >
316
+ </ li >
317
+
318
+
319
+ </ ul >
320
+ </ nav >
321
+ </ div >
322
+ </ div >
323
+ </ div >
324
+
325
+
326
+
327
+ < div class ="md-content ">
328
+ < article class ="md-content__inner md-typeset ">
329
+
330
+ < h1 > 404 - Not found</ h1 >
331
+
332
+
333
+
334
+
335
+
336
+
337
+ </ article >
338
+ </ div >
339
+ </ div >
340
+ </ main >
341
+
342
+
343
+ < footer class ="md-footer ">
344
+
345
+ < div class ="md-footer-meta md-typeset ">
346
+ < div class ="md-footer-meta__inner md-grid ">
347
+ < div class ="md-footer-copyright ">
348
+
349
+ powered by
350
+ < a href ="https://www.mkdocs.org "> MkDocs</ a >
351
+ and
352
+ < a href ="https://squidfunk.github.io/mkdocs-material/ ">
353
+ Material for MkDocs</ a >
354
+ </ div >
355
+
356
+ </ div >
357
+ </ div >
358
+ </ footer >
359
+
360
+ </ div >
361
+
362
+ < script src ="/assets/javascripts/application.808e90bb.js "> </ script >
363
+
364
+ < script > app . initialize ( { version :"1.0.4" , url :{ base :"/" } } ) </ script >
365
+
366
+
367
+ </ body >
368
+ </ html >
0 commit comments