Make parameter nodes inherit from sig classes

Author: TLouf

sphinx/addnodes.py

@@ -181,13 +181,6 @@ class desc_content(nodes.General, nodes.Element):
     """
 
 
-class desc_compact_content(nodes.General, nodes.Element):
-    """Node for compact object description content.
-
-    Must be the last child node in a :py:class:`desc` node.
-    """
-
-
 class desc_inline(_desc_classes_injector, nodes.Inline, nodes.TextElement):
     """Node for a signature fragment in inline text.
 
@@ -254,6 +247,15 @@ def astext(self):
         return f'({super().astext()})'
 
 
+class desc_multiline_parameterlist(nodes.Part, nodes.Inline, nodes.FixedTextElement):
+    """Node for a multiline parameter list.
+    """
+    child_text_separator = ', '
+
+    def astext(self):
+        return f'({super().astext()})'
+
+
 class desc_parameter(nodes.Part, nodes.Inline, nodes.FixedTextElement):
     """Node for a single parameter."""
 

sphinx/domains/python.py

@@ -228,11 +228,11 @@ def _parse_arglist(
     arglist: str, env: Optional[BuildEnvironment] = None, multiline=False
 ) -> addnodes.desc_parameterlist:
     """Parse a list of arguments using AST parser"""
-    params = addnodes.desc_parameterlist(arglist)
+    params = addnodes.desc_multiline_parameterlist(arglist) if multiline else addnodes.desc_parameterlist(arglist)
     sig = signature_from_str('(%s)' % arglist)
     last_kind = None
     for param in sig.parameters.values():
-        param_node = addnodes.desc_compact_content() if multiline else params
+        param_node = addnodes.desc_content() if multiline else params
         if param.kind != param.POSITIONAL_ONLY and last_kind == param.POSITIONAL_ONLY:
             # PEP-570: Separator for Positional Only Parameter: /
             param_node += addnodes.desc_parameter('', '', addnodes.desc_sig_operator('', '/'))

sphinx/themes/basic/static/basic.css_t

@@ -670,7 +670,7 @@ dd {
     margin-left: 30px;
 }
 
-dd.compact {
+.sig dd {
     margin-top: 0px;
     margin-bottom: 0px;
 }

sphinx/writers/html5.py

@@ -112,12 +112,6 @@ def visit_desc_content(self, node: Element) -> None:
     def depart_desc_content(self, node: Element) -> None:
         self.body.append('</dd>')
 
-    def visit_desc_compact_content(self, node: Element) -> None:
-        self.body.append(self.starttag(node, 'dd', '', classes=['compact']))
-
-    def depart_desc_compact_content(self, node: Element) -> None:
-        self.body.append('</dd>')
-
     def visit_desc_inline(self, node: Element) -> None:
         self.body.append(self.starttag(node, 'span', ''))
 
@@ -165,6 +159,20 @@ def visit_desc_parameterlist(self, node: Element) -> None:
     def depart_desc_parameterlist(self, node: Element) -> None:
         self.body.append('<span class="sig-paren">)</span>')
 
+    def visit_desc_multiline_parameterlist(self, node: Element) -> None:
+        self.body.append('<span class="sig-paren">(</span>')
+        self.first_param = 1
+        self.optional_param_level = 0
+        # How many required parameters are left.
+        self.required_params_left = sum([isinstance(c, addnodes.desc_parameter)
+                                         for c in node.children])
+        self.param_separator = node.child_text_separator
+        self.body.append(self.starttag(node, 'dl'))
+
+    def depart_desc_multiline_parameterlist(self, node: Element) -> None:
+        self.body.append('</dl>\n\n')
+        self.body.append('<span class="sig-paren">)</span>')
+
     # If required parameters are still to come, then put the comma after
     # the parameter.  Otherwise, put the comma before.  This ensures that
     # signatures like the following render correctly (see issue #1001):