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