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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
|
"""
=========
Constants
=========
Numpy includes several constants:
%(constant_list)s
"""
import textwrap
# Maintain same format as in numpy.add_newdocs
constants = []
def add_newdoc(module, name, doc):
constants.append((name, doc))
add_newdoc('numpy', 'Inf',
"""
""")
add_newdoc('numpy', 'Infinity',
"""
""")
add_newdoc('numpy', 'NAN',
"""
""")
add_newdoc('numpy', 'NINF',
"""
""")
add_newdoc('numpy', 'NZERO',
"""
""")
add_newdoc('numpy', 'NaN',
"""
""")
add_newdoc('numpy', 'PINF',
"""
""")
add_newdoc('numpy', 'PZERO',
"""
""")
add_newdoc('numpy', 'e',
"""
""")
add_newdoc('numpy', 'inf',
"""
""")
add_newdoc('numpy', 'infty',
"""
""")
add_newdoc('numpy', 'nan',
"""
""")
add_newdoc('numpy', 'newaxis',
"""
""")
if __doc__:
constants_str = []
constants.sort()
for name, doc in constants:
constants_str.append(""".. const:: %s\n %s""" % (
name, textwrap.dedent(doc).replace("\n", "\n ")))
constants_str = "\n".join(constants_str)
__doc__ = __doc__ % dict(constant_list=constants_str)
del constants_str, name, doc
del constants, add_newdoc
|
