##// END OF EJS Templates
Update API doc skip patterns
Thomas Kluyver -
Show More
@@ -1,66 +1,49 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 # stdlib imports
4 # stdlib imports
5 import os
5 import os
6 import sys
6 import sys
7
7
8 # local imports
8 # local imports
9 sys.path.append(os.path.abspath('sphinxext'))
9 sys.path.append(os.path.abspath('sphinxext'))
10 from apigen import ApiDocWriter
10 from apigen import ApiDocWriter
11
11
12 #*****************************************************************************
12 #*****************************************************************************
13 if __name__ == '__main__':
13 if __name__ == '__main__':
14 pjoin = os.path.join
14 pjoin = os.path.join
15 package = 'IPython'
15 package = 'IPython'
16 outdir = pjoin('source','api','generated')
16 outdir = pjoin('source','api','generated')
17 docwriter = ApiDocWriter(package,rst_extension='.rst')
17 docwriter = ApiDocWriter(package,rst_extension='.rst')
18 # You have to escape the . here because . is a special char for regexps.
18 # You have to escape the . here because . is a special char for regexps.
19 # You must do make clean if you change this!
19 # You must do make clean if you change this!
20 docwriter.package_skip_patterns += [r'\.fixes$',
20 docwriter.package_skip_patterns += [r'\.external$',
21 r'\.external$',
21 # Extensions are documented elsewhere.
22 r'\.extensions',
22 r'\.extensions',
23 r'\.kernel\.config',
24 r'\.attic',
25 r'\.quarantine',
26 r'\.deathrow',
27 r'\.config\.default',
28 r'\.config\.profile',
23 r'\.config\.profile',
29 r'\.frontend',
30 r'\.gui',
31 r'\.kernel',
32 # For now, the zmq code has
33 # unconditional top-level code so it's
34 # not import safe. This needs fixing
35 r'\.zmq',
36 ]
24 ]
37
25
38 docwriter.module_skip_patterns += [
26 # The inputhook* modules often cause problems on import, such as trying to
39 r'\.testing\.iptest',
27 # load incompatible Qt bindings. It's easiest to leave them all out. The
40 # Keeping these disabled is OK
28 # main API is in the inputhook module, which is documented.
41 r'\.parallel\.controller\.mongodb',
29 docwriter.module_skip_patterns += [ r'\.lib\.inputhook.+',
42 r'\.lib\.inputhookwx',
43 r'\.lib\.inputhookgtk',
44 r'\.cocoa',
45 r'\.ipdoctest',
30 r'\.ipdoctest',
46 r'\.Gnuplot',
31 # This just prints a deprecation msg:
47 r'\.frontend\.process\.winprocess',
48 r'\.frontend',
32 r'\.frontend',
49 r'\.Shell',
50 ]
33 ]
51
34
52 # If we don't have pexpect, we can't load irunner, so skip any code that
35 # We're rarely working on machines with the Azure SDK installed, so we
53 # depends on it
36 # skip the module that needs it in that case.
54 try:
37 try:
55 import pexpect
38 import azure # analysis:ignore
56 except ImportError:
39 except ImportError:
57 docwriter.module_skip_patterns += [r'\.lib\.irunner',
40 docwriter.module_skip_patterns.append(r'\.html\.services\.notebooks\.azurenbmanager')
58 r'\.testing\.mkdoctests']
41
59 # Now, generate the outputs
42 # Now, generate the outputs
60 docwriter.write_api_docs(outdir)
43 docwriter.write_api_docs(outdir)
61 # Write index with .txt extension - we can include it, but Sphinx won't try
44 # Write index with .txt extension - we can include it, but Sphinx won't try
62 # to compile it
45 # to compile it
63 docwriter.write_index(outdir, 'gen.txt',
46 docwriter.write_index(outdir, 'gen.txt',
64 relative_to = pjoin('source','api')
47 relative_to = pjoin('source','api')
65 )
48 )
66 print ('%d files written' % len(docwriter.written_modules))
49 print ('%d files written' % len(docwriter.written_modules))
General Comments 0
You need to be logged in to leave comments. Login now