Show More
@@ -1,33 +1,34 b'' | |||
|
1 | 1 | #!/usr/bin/env python |
|
2 | 2 | """Script to auto-generate our API docs. |
|
3 | 3 | """ |
|
4 | 4 | # stdlib imports |
|
5 | 5 | import os |
|
6 | 6 | import sys |
|
7 | 7 | |
|
8 | 8 | # local imports |
|
9 | 9 | sys.path.append(os.path.abspath('sphinxext')) |
|
10 | 10 | from apigen import ApiDocWriter |
|
11 | 11 | |
|
12 | 12 | #***************************************************************************** |
|
13 | 13 | if __name__ == '__main__': |
|
14 | 14 | pjoin = os.path.join |
|
15 | 15 | package = 'IPython' |
|
16 | 16 | outdir = pjoin('source','api','generated') |
|
17 | 17 | docwriter = ApiDocWriter(package,rst_extension='.txt') |
|
18 | 18 | docwriter.package_skip_patterns += [r'\.fixes$', |
|
19 | 19 | r'\.externals$', |
|
20 | 20 | r'\.Extensions', |
|
21 | 21 | r'\.kernel.config', |
|
22 | 22 | r'\.attic', |
|
23 | 23 | ] |
|
24 | 24 | docwriter.module_skip_patterns += [ r'\.FakeModule', |
|
25 | 25 | r'\.cocoa', |
|
26 | 26 | r'\.ipdoctest', |
|
27 | 27 | r'\.Gnuplot', |
|
28 | r'\.frontend.process.winprocess', | |
|
28 | 29 | ] |
|
29 | 30 | docwriter.write_api_docs(outdir) |
|
30 | 31 | docwriter.write_index(outdir, 'gen', |
|
31 | 32 | relative_to = pjoin('source','api') |
|
32 | 33 | ) |
|
33 | 34 | print '%d files written' % len(docwriter.written_modules) |
General Comments 0
You need to be logged in to leave comments.
Login now