Skip to content

Commit

Permalink
Fix parsing of options with enabled option_emphasise_placeholders
Browse files Browse the repository at this point in the history
If the option is enabled, the current code wrongly uses

if not args:
  continue

which skips adjustment of signode and firstname
at the very of the loop.

Fixes: sphinx-doc#10366.
  • Loading branch information
marxin committed Jun 17, 2022
1 parent c40bb72 commit 8ed1955
Showing 1 changed file with 16 additions and 17 deletions.
33 changes: 16 additions & 17 deletions sphinx/domains/std.py
Expand Up @@ -186,23 +186,22 @@ def handle_signature(self, sig: str, signode: desc_signature) -> str:
signode += addnodes.desc_name(optname, optname)
if self.env.config.option_emphasise_placeholders:
add_end_bracket = False
if not args:
continue
if args[0] == '[' and args[-1] == ']':
add_end_bracket = True
signode += addnodes.desc_sig_punctuation('[', '[')
args = args[1:-1]
if args[0] == ' ':
signode += addnodes.desc_sig_space()
args = args.strip()
if args[0] == '=':
signode += addnodes.desc_sig_punctuation('=', '=')
args = args[1:]
for part in samp_role.parse(args):
if isinstance(part, nodes.Text):
signode += nodes.Text(part.astext())
else:
signode += part
if args:
if args[0] == '[' and args[-1] == ']':
add_end_bracket = True
signode += addnodes.desc_sig_punctuation('[', '[')
args = args[1:-1]
elif args[0] == ' ':
signode += addnodes.desc_sig_space()
args = args.strip()
elif args[0] == '=':
signode += addnodes.desc_sig_punctuation('=', '=')
args = args[1:]
for part in samp_role.parse(args):
if isinstance(part, nodes.Text):
signode += nodes.Text(part.astext())
else:
signode += part
if add_end_bracket:
signode += addnodes.desc_sig_punctuation(']', ']')
else:
Expand Down

0 comments on commit 8ed1955

Please sign in to comment.