summaryrefslogtreecommitdiffstats
path: root/external_libs/python/pyzmq-14.7.0/docs/autogen_api.py
diff options
context:
space:
mode:
Diffstat (limited to 'external_libs/python/pyzmq-14.7.0/docs/autogen_api.py')
-rw-r--r--external_libs/python/pyzmq-14.7.0/docs/autogen_api.py48
1 files changed, 48 insertions, 0 deletions
diff --git a/external_libs/python/pyzmq-14.7.0/docs/autogen_api.py b/external_libs/python/pyzmq-14.7.0/docs/autogen_api.py
new file mode 100644
index 00000000..004c4612
--- /dev/null
+++ b/external_libs/python/pyzmq-14.7.0/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))