From 05339cadbe17fef2590be26c9063c2f909554660 2015-08-06 16:09:12
From: Thomas Kluyver <takowl@gmail.com>
Date: 2015-08-06 16:09:12
Subject: [PATCH] Fix up generated API docs

---

diff --git a/IPython/paths.py b/IPython/paths.py
index ac94118..5978772 100644
--- a/IPython/paths.py
+++ b/IPython/paths.py
@@ -1,3 +1,5 @@
+"""Find files and directories which IPython uses.
+"""
 import os.path
 import shutil
 import tempfile
diff --git a/docs/autogen_api.py b/docs/autogen_api.py
index ede971e..b0bb53c 100755
--- a/docs/autogen_api.py
+++ b/docs/autogen_api.py
@@ -20,54 +20,45 @@ if __name__ == '__main__':
     docwriter.package_skip_patterns += [r'\.external$',
                                         # Extensions are documented elsewhere.
                                         r'\.extensions',
-                                        r'\.config\.profile',
-                                        # Old nbformat versions
-                                        r'\.nbformat\.v[1-2]',
-                                        # Public API for this is in kernel.zmq.eventloops
-                                        r'\.kernel\.zmq\.gui',
                                         # Magics are documented separately
                                         r'\.core\.magics',
+                                        # This isn't API
+                                        r'\.sphinxext',
+                                        # Shims
+                                        r'\.kernel',
                                         ]
 
     # The inputhook* modules often cause problems on import, such as trying to
     # load incompatible Qt bindings. It's easiest to leave them all out. The
-    # main API is in the inputhook module, which is documented.
     docwriter.module_skip_patterns += [ r'\.lib\.inputhook.+',
                                         r'\.ipdoctest',
                                         r'\.testing\.plugin',
-                                        # This just prints a deprecation msg:
-                                        r'\.frontend$',
                                         # Deprecated:
                                         r'\.core\.magics\.deprecated',
                                         # Backwards compat import for lib.lexers
                                         r'\.nbconvert\.utils\.lexers',
                                         # We document this manually.
                                         r'\.utils\.py3compat',
-                                        # These are exposed by nbformat
-                                        r'\.nbformat\.convert',
-                                        r'\.nbformat\.validator',
-                                        r'\.nbformat\.notebooknode',
-                                        # Deprecated
-                                        r'\.nbformat\.current',
-                                        # Exposed by nbformat.vN
-                                        r'\.nbformat\.v[3-4]\.nbbase',
                                         # These are exposed in display
                                         r'\.core\.display',
                                         r'\.lib\.display',
-                                        # This isn't actually a module
-                                        r'\.html\.tasks',
-                                        # This is private
-                                        r'\.html\.allow76'
+                                        # Shims
+                                        r'\.config',
+                                        r'\.consoleapp',
+                                        r'\.frontend$',
+                                        r'\.html',
+                                        r'\.nbconvert',
+                                        r'\.nbformat',
+                                        r'\.parallel',
+                                        r'\.qt',
                                         ]
+    # main API is in the inputhook module, which is documented.
 
     # These modules import functions and classes from other places to expose
     # them as part of the public API. They must have __all__ defined. The
     # non-API modules they import from should be excluded by the skip patterns
     # above.
     docwriter.names_from__all__.update({
-        'IPython.nbformat',
-        'IPython.nbformat.v3',
-        'IPython.nbformat.v4',
         'IPython.display',
     })