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