Skip to content

Commit 3599f7d

Browse files
committed
Make fallback for changed get_signature_prefix()
Fixes #9832
1 parent 6c6cc8a commit 3599f7d

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

sphinx/domains/python.py

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -495,7 +495,13 @@ def handle_signature(self, sig: str, signode: desc_signature) -> Tuple[str, str]
495495

496496
sig_prefix = self.get_signature_prefix(sig)
497497
if sig_prefix:
498-
signode += addnodes.desc_annotation(str(sig_prefix), '', *sig_prefix)
498+
if type(sig_prefix) is str:
499+
logger.warning("Python directive get_signature_prefix() returns a str ('{}')"
500+
" instead of a list of nodes (changed in 4.3).".format(sig_prefix),
501+
location=signode)
502+
signode += addnodes.desc_annotation(sig_prefix, '', nodes.Text(sig_prefix, sig_prefix))
503+
else:
504+
signode += addnodes.desc_annotation(str(sig_prefix), '', *sig_prefix)
499505

500506
if prefix:
501507
signode += addnodes.desc_addname(prefix, prefix)

0 commit comments

Comments
 (0)