mirror of https://github.com/zeromq/pyzmq.git
51 lines
1.4 KiB
Python
Executable File
51 lines
1.4 KiB
Python
Executable File
#!/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'\.auth\.ioloop$',
|
|
r'\.eventloop\.ioloop$',
|
|
r'\.eventloop\.stack_context$',
|
|
r'\.eventloop\.future$',
|
|
r'\.error$',
|
|
r'\.green\..+$',
|
|
r'\.utils\.initthreads$',
|
|
r'\.utils\.constant_names$',
|
|
r'\.utils\.garbage$',
|
|
r'\.utils\.rebuffer$',
|
|
r'\.utils\.strtypes$',
|
|
r'\.zmq$',
|
|
]
|
|
|
|
# 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))
|