Show More
@@ -1,76 +1,75 | |||
|
1 | 1 | #!/usr/bin/env python |
|
2 | 2 | """Script to auto-generate our API docs. |
|
3 | 3 | """ |
|
4 | 4 | |
|
5 | 5 | import os |
|
6 | 6 | import sys |
|
7 | 7 | |
|
8 | 8 | pjoin = os.path.join |
|
9 | 9 | |
|
10 | 10 | here = os.path.abspath(os.path.dirname(__file__)) |
|
11 | 11 | sys.path.append(pjoin(os.path.abspath(here), 'sphinxext')) |
|
12 | 12 | |
|
13 | 13 | from apigen import ApiDocWriter |
|
14 | 14 | |
|
15 | 15 | source = pjoin(here, 'source') |
|
16 | 16 | |
|
17 | 17 | #***************************************************************************** |
|
18 | 18 | if __name__ == '__main__': |
|
19 | 19 | package = 'IPython' |
|
20 | 20 | outdir = pjoin(source, 'api', 'generated') |
|
21 | 21 | docwriter = ApiDocWriter(package,rst_extension='.rst') |
|
22 | 22 | # You have to escape the . here because . is a special char for regexps. |
|
23 | 23 | # You must do make clean if you change this! |
|
24 | 24 | docwriter.package_skip_patterns += [r'\.external$', |
|
25 | 25 | # Extensions are documented elsewhere. |
|
26 | 26 | r'\.extensions', |
|
27 | 27 | # Magics are documented separately |
|
28 | 28 | r'\.core\.magics', |
|
29 | 29 | # This isn't API |
|
30 | 30 | r'\.sphinxext', |
|
31 | 31 | # Shims |
|
32 | 32 | r'\.kernel', |
|
33 | r'\.terminal\.pt_inputhooks', | |
|
33 | 34 | ] |
|
34 | 35 | |
|
35 | 36 | # The inputhook* modules often cause problems on import, such as trying to |
|
36 | 37 | # load incompatible Qt bindings. It's easiest to leave them all out. The |
|
37 | 38 | docwriter.module_skip_patterns += [ r'\.lib\.inputhook.+', |
|
38 | 39 | r'\.ipdoctest', |
|
39 | 40 | r'\.testing\.plugin', |
|
40 | # Deprecated: | |
|
41 | r'\.core\.magics\.deprecated', | |
|
42 | 41 | # Backwards compat import for lib.lexers |
|
43 | 42 | r'\.nbconvert\.utils\.lexers', |
|
44 | 43 | # We document this manually. |
|
45 | 44 | r'\.utils\.py3compat', |
|
46 | 45 | # These are exposed in display |
|
47 | 46 | r'\.core\.display', |
|
48 | 47 | r'\.lib\.display', |
|
49 | 48 | # Shims |
|
50 | 49 | r'\.config', |
|
51 | 50 | r'\.consoleapp', |
|
52 | 51 | r'\.frontend$', |
|
53 | 52 | r'\.html', |
|
54 | 53 | r'\.nbconvert', |
|
55 | 54 | r'\.nbformat', |
|
56 | 55 | r'\.parallel', |
|
57 | 56 | r'\.qt', |
|
58 | 57 | ] |
|
59 | 58 | # main API is in the inputhook module, which is documented. |
|
60 | 59 | |
|
61 | 60 | # These modules import functions and classes from other places to expose |
|
62 | 61 | # them as part of the public API. They must have __all__ defined. The |
|
63 | 62 | # non-API modules they import from should be excluded by the skip patterns |
|
64 | 63 | # above. |
|
65 | 64 | docwriter.names_from__all__.update({ |
|
66 | 65 | 'IPython.display', |
|
67 | 66 | }) |
|
68 | 67 | |
|
69 | 68 | # Now, generate the outputs |
|
70 | 69 | docwriter.write_api_docs(outdir) |
|
71 | 70 | # Write index with .txt extension - we can include it, but Sphinx won't try |
|
72 | 71 | # to compile it |
|
73 | 72 | docwriter.write_index(outdir, 'gen.txt', |
|
74 | 73 | relative_to = pjoin(source, 'api') |
|
75 | 74 | ) |
|
76 | 75 | print ('%d files written' % len(docwriter.written_modules)) |
General Comments 0
You need to be logged in to leave comments.
Login now