##// END OF EJS Templates
Fix up generated API docs
Thomas Kluyver -
Show More
@@ -1,3 +1,5 b''
1 """Find files and directories which IPython uses.
2 """
1 3 import os.path
2 4 import shutil
3 5 import tempfile
@@ -20,54 +20,45 b" if __name__ == '__main__':"
20 20 docwriter.package_skip_patterns += [r'\.external$',
21 21 # Extensions are documented elsewhere.
22 22 r'\.extensions',
23 r'\.config\.profile',
24 # Old nbformat versions
25 r'\.nbformat\.v[1-2]',
26 # Public API for this is in kernel.zmq.eventloops
27 r'\.kernel\.zmq\.gui',
28 23 # Magics are documented separately
29 24 r'\.core\.magics',
25 # This isn't API
26 r'\.sphinxext',
27 # Shims
28 r'\.kernel',
30 29 ]
31 30
32 31 # The inputhook* modules often cause problems on import, such as trying to
33 32 # load incompatible Qt bindings. It's easiest to leave them all out. The
34 # main API is in the inputhook module, which is documented.
35 33 docwriter.module_skip_patterns += [ r'\.lib\.inputhook.+',
36 34 r'\.ipdoctest',
37 35 r'\.testing\.plugin',
38 # This just prints a deprecation msg:
39 r'\.frontend$',
40 36 # Deprecated:
41 37 r'\.core\.magics\.deprecated',
42 38 # Backwards compat import for lib.lexers
43 39 r'\.nbconvert\.utils\.lexers',
44 40 # We document this manually.
45 41 r'\.utils\.py3compat',
46 # These are exposed by nbformat
47 r'\.nbformat\.convert',
48 r'\.nbformat\.validator',
49 r'\.nbformat\.notebooknode',
50 # Deprecated
51 r'\.nbformat\.current',
52 # Exposed by nbformat.vN
53 r'\.nbformat\.v[3-4]\.nbbase',
54 42 # These are exposed in display
55 43 r'\.core\.display',
56 44 r'\.lib\.display',
57 # This isn't actually a module
58 r'\.html\.tasks',
59 # This is private
60 r'\.html\.allow76'
45 # Shims
46 r'\.config',
47 r'\.consoleapp',
48 r'\.frontend$',
49 r'\.html',
50 r'\.nbconvert',
51 r'\.nbformat',
52 r'\.parallel',
53 r'\.qt',
61 54 ]
55 # main API is in the inputhook module, which is documented.
62 56
63 57 # These modules import functions and classes from other places to expose
64 58 # them as part of the public API. They must have __all__ defined. The
65 59 # non-API modules they import from should be excluded by the skip patterns
66 60 # above.
67 61 docwriter.names_from__all__.update({
68 'IPython.nbformat',
69 'IPython.nbformat.v3',
70 'IPython.nbformat.v4',
71 62 'IPython.display',
72 63 })
73 64
General Comments 0
You need to be logged in to leave comments. Login now