Skip to content

Commit 9ec4698

Browse files
committed
Use new desc_parameterline instead of desc_content
1 parent 8ca560d commit 9ec4698

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
@@ -249,6 +249,10 @@ def astext(self):
249249
return f'({super().astext()})'
250250

251251

252+
class desc_parameterline(nodes.General, nodes.Element):
253+
"""Node for a parameter line."""
254+
255+
252256
class desc_parameter(nodes.Part, nodes.Inline, nodes.FixedTextElement):
253257
"""Node for a single parameter."""
254258

sphinx/domains/c.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -725,7 +725,7 @@ def describe_signature(self, signode: TextElement, mode: str,
725725
paramlist = addnodes.desc_parameterlist()
726726
paramlist['is_multiline'] = multiline
727727
for arg in self.args:
728-
param_node = addnodes.desc_content() if multiline else paramlist
728+
param_node = addnodes.desc_parameterline() if multiline else paramlist
729729
param = addnodes.desc_parameter('', '', noemph=True)
730730
arg.describe_signature(param, 'param', env, symbol=symbol)
731731
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
@@ -259,7 +259,7 @@ def _parse_arglist(
259259
sig = signature_from_str('(%s)' % arglist)
260260
last_kind = None
261261
for param in sig.parameters.values():
262-
param_node = addnodes.desc_content() if multiline else params
262+
param_node = addnodes.desc_parameterline() if multiline else params
263263
if param.kind != param.POSITIONAL_ONLY and last_kind == param.POSITIONAL_ONLY:
264264
# PEP-570: Separator for Positional Only Parameter: /
265265
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
@@ -165,6 +165,12 @@ def depart_desc_parameterlist(self, node: Element) -> None:
165165
self.body.append('</dl>\n\n')
166166
self.body.append('<span class="sig-paren">)</span>')
167167

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

0 commit comments

Comments
 (0)