1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
|
"""
Module for testing the autodocsumm
----------------------------------
Just a dummy module with some class definitions
"""
#: to test if the data is included
test_data = None
def test_func():
"""Test if function is contained in autosummary"""
pass
class Class_CallTest(object):
"""A class defining a __call__ method"""
def __get__(self, instance, owner):
return self
def __set__(self, instance, value):
"""Actually not required. We just implement it to ensure the python
"help" function works well"""
pass
def __call__(self, a, b):
"""
Caller docstring for class attribute
Parameters
----------
a: any
dummy parameter
b: anything else
second dummy parameter"""
pass
class TestClass(object):
"""Class test for autosummary"""
def test_method(self):
"""Test if the method is included"""
pass
#: to test if the class attribute is included
test_attr = None
class_caller = Class_CallTest()
#: data to be included
large_data = 'Should be included'
#: data to be skipped
small_data = 'Should be skipped'
#: data to be skipped
large_data = 'Should also be skipped'
#: data to be included
small_data = 'Should also be included'
|
