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
|
#!/usr/bin/env python
"""Script to auto-generate our API docs.
"""
# stdlib imports
import os
import sys
# local imports
sys.path.append(os.path.abspath('sphinxext'))
# import sphinx_cython
from apigen import ApiDocWriter
#*****************************************************************************
if __name__ == '__main__':
pjoin = os.path.join
package = 'zmq'
outdir = pjoin('source','api','generated')
docwriter = ApiDocWriter(package,rst_extension='.rst')
# You have to escape the . here because . is a special char for regexps.
# You must do make clean if you change this!
docwriter.package_skip_patterns += [
r'\.tests$',
r'\.backend$',
r'\.auth$',
r'\.eventloop\.minitornado$',
r'\.green\.eventloop$',
r'\.sugar$',
r'\.devices$',
]
docwriter.module_skip_patterns += [
r'\.eventloop\.stack_context$',
r'\.error$',
r'\.green\..+$',
r'\.utils\.initthreads$',
r'\.utils\.constant_names$',
r'\.utils\.garbage$',
r'\.utils\.rebuffer$',
r'\.utils\.strtypes$',
]
# Now, generate the outputs
docwriter.write_api_docs(outdir)
docwriter.write_index(outdir, 'gen',
relative_to = pjoin('source','api')
)
print('%d files written' % len(docwriter.written_modules))
|
