diff options
author | Micah Anderson <micah@riseup.net> | 2014-11-11 11:53:55 -0500 |
---|---|---|
committer | Micah Anderson <micah@riseup.net> | 2014-11-11 11:53:55 -0500 |
commit | 7d5c3dcd969161322deed6c43f8a6a3cb92c3369 (patch) | |
tree | 109b05c88c7252d7609ef324d62ef9dd7f06123f /docs/autogen_api.py | |
parent | 44be832c5708baadd146cb954befbc3dcad8d463 (diff) |
upgrade to 14.4.1upstream/14.4.1
Diffstat (limited to 'docs/autogen_api.py')
-rwxr-xr-x | docs/autogen_api.py | 48 |
1 files changed, 48 insertions, 0 deletions
diff --git a/docs/autogen_api.py b/docs/autogen_api.py new file mode 100755 index 0000000..004c461 --- /dev/null +++ b/docs/autogen_api.py @@ -0,0 +1,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)) |