Skip to content

Commit 82f1cb7

Browse files
committed
Use new desc_parameterline instead of desc_content
1 parent 3defcde commit 82f1cb7

File tree

5 files changed

+13
-3
lines changed

5 files changed

+13
-3
lines changed

sphinx/addnodes.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -247,6 +247,10 @@ def astext(self):
247247
return f'({super().astext()})'
248248

249249

250+
class desc_parameterline(nodes.General, nodes.Element):
251+
"""Node for a parameter line."""
252+
253+
250254
class desc_parameter(nodes.Part, nodes.Inline, nodes.FixedTextElement):
251255
"""Node for a single parameter."""
252256

sphinx/domains/c.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -724,7 +724,7 @@ def describe_signature(self, signode: TextElement, mode: str,
724724
paramlist = addnodes.desc_parameterlist()
725725
paramlist['is_multiline'] = multiline
726726
for arg in self.args:
727-
param_node = addnodes.desc_content() if multiline else paramlist
727+
param_node = addnodes.desc_parameterline() if multiline else paramlist
728728
param = addnodes.desc_parameter('', '', noemph=True)
729729
arg.describe_signature(param, 'param', env, symbol=symbol)
730730
param_node += param

sphinx/domains/cpp.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2136,7 +2136,7 @@ def describe_signature(self, signode: TextElement, mode: str,
21362136
paramlist = addnodes.desc_parameterlist()
21372137
paramlist['is_multiline'] = multiline
21382138
for arg in self.args:
2139-
param_node = addnodes.desc_content() if multiline else paramlist
2139+
param_node = addnodes.desc_parameterline() if multiline else paramlist
21402140
param = addnodes.desc_parameter('', '', noemph=True)
21412141
arg.describe_signature(param, 'param', env, symbol=symbol)
21422142
param_node += param

sphinx/domains/python.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,7 @@ def _parse_arglist(
233233
sig = signature_from_str('(%s)' % arglist)
234234
last_kind = None
235235
for param in sig.parameters.values():
236-
param_node = addnodes.desc_content() if multiline else params
236+
param_node = addnodes.desc_parameterline() if multiline else params
237237
if param.kind != param.POSITIONAL_ONLY and last_kind == param.POSITIONAL_ONLY:
238238
# PEP-570: Separator for Positional Only Parameter: /
239239
param_node += addnodes.desc_parameter('', '', addnodes.desc_sig_operator('', '/'))

sphinx/writers/html5.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -163,6 +163,12 @@ def depart_desc_parameterlist(self, node: Element) -> None:
163163
self.body.append('</dl>\n\n')
164164
self.body.append('<span class="sig-paren">)</span>')
165165

166+
def visit_desc_parameterline(self, node: Element) -> None:
167+
self.body.append(self.starttag(node, 'dd', ''))
168+
169+
def depart_desc_parameterline(self, node: Element) -> None:
170+
self.body.append('</dd>')
171+
166172
# If required parameters are still to come, then put the comma after
167173
# the parameter. Otherwise, put the comma before. This ensures that
168174
# signatures like the following render correctly (see issue #1001):

0 commit comments

Comments
 (0)