##// END OF EJS Templates
Update API doc skip patterns
Thomas Kluyver -
Show More
@@ -17,45 +17,28 b" if __name__ == '__main__':"
17 17 docwriter = ApiDocWriter(package,rst_extension='.rst')
18 18 # You have to escape the . here because . is a special char for regexps.
19 19 # You must do make clean if you change this!
20 docwriter.package_skip_patterns += [r'\.fixes$',
21 r'\.external$',
20 docwriter.package_skip_patterns += [r'\.external$',
21 # Extensions are documented elsewhere.
22 22 r'\.extensions',
23 r'\.kernel\.config',
24 r'\.attic',
25 r'\.quarantine',
26 r'\.deathrow',
27 r'\.config\.default',
28 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 += [
39 r'\.testing\.iptest',
40 # Keeping these disabled is OK
41 r'\.parallel\.controller\.mongodb',
42 r'\.lib\.inputhookwx',
43 r'\.lib\.inputhookgtk',
44 r'\.cocoa',
26 # The inputhook* modules often cause problems on import, such as trying to
27 # load incompatible Qt bindings. It's easiest to leave them all out. The
28 # main API is in the inputhook module, which is documented.
29 docwriter.module_skip_patterns += [ r'\.lib\.inputhook.+',
45 30 r'\.ipdoctest',
46 r'\.Gnuplot',
47 r'\.frontend\.process\.winprocess',
31 # This just prints a deprecation msg:
48 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
53 # depends on it
35 # We're rarely working on machines with the Azure SDK installed, so we
36 # skip the module that needs it in that case.
54 37 try:
55 import pexpect
38 import azure # analysis:ignore
56 39 except ImportError:
57 docwriter.module_skip_patterns += [r'\.lib\.irunner',
58 r'\.testing\.mkdoctests']
40 docwriter.module_skip_patterns.append(r'\.html\.services\.notebooks\.azurenbmanager')
41
59 42 # Now, generate the outputs
60 43 docwriter.write_api_docs(outdir)
61 44 # Write index with .txt extension - we can include it, but Sphinx won't try
General Comments 0
You need to be logged in to leave comments. Login now