Merge pull request #13503 from martinRenou/sphinxify

Carreau · web-flow · commit 8520f3063ca3 · 2022-02-01T21:02:15.000+01:00
Update sphinxify usage
diff --git a/IPython/core/interactiveshell.py b/IPython/core/interactiveshell.py
@@ -90,12 +90,17 @@
 try:
     import docrepr.sphinxify as sphx
 
-    def sphinxify(doc):
-        with TemporaryDirectory() as dirname:
-            return {
-                'text/html': sphx.sphinxify(doc, dirname),
-                'text/plain': doc
-            }
+    def sphinxify(oinfo):
+        wrapped_docstring = sphx.wrap_main_docstring(oinfo)
+
+        def sphinxify_docstring(docstring):
+            with TemporaryDirectory() as dirname:
+                return {
+                    "text/html": sphx.sphinxify(wrapped_docstring, dirname),
+                    "text/plain": docstring,
+                }
+
+        return sphinxify_docstring
 except ImportError:
     sphinxify = None
 
@@ -772,7 +777,7 @@ def init_virtualenv(self):
         while p.is_symlink():
             p = Path(os.readlink(p))
             paths.append(p.resolve())
-        
+
         # In Cygwin paths like "c:\..." and '\cygdrive\c\...' are possible
         if p_venv.parts[1] == "cygdrive":
             drive_name = p_venv.parts[2]
@@ -1621,7 +1626,9 @@ def _inspect(self, meth, oname, namespaces=None, **kw):
         This function is meant to be called by pdef, pdoc & friends.
         """
         info = self._object_find(oname, namespaces)
-        docformat = sphinxify if self.sphinxify_docstring else None
+        docformat = (
+            sphinxify(self.object_inspect(oname)) if self.sphinxify_docstring else None
+        )
         if info.found:
             pmethod = getattr(self.inspector, meth)
             # TODO: only apply format_screen to the plain/text repr of the mime
@@ -1668,7 +1675,11 @@ def object_inspect_mime(self, oname, detail_level=0, omit_sections=()):
         with self.builtin_trap:
             info = self._object_find(oname)
             if info.found:
-                docformat = sphinxify if self.sphinxify_docstring else None
+                docformat = (
+                    sphinxify(self.object_inspect(oname))
+                    if self.sphinxify_docstring
+                    else None
+                )
                 return self.inspector._get_info(
                     info.obj,
                     oname,
