IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

py nodes, prep for get_signature_prefix change

Browse Source
This commit is contained in:
Jakob Lykke Andersen 2021-09-25 12:42:40 +02:00
parent 8cd0847590
commit edc65e676c
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
sphinx/domains/python.py
View File

@ -424,11 +424,11 @@ class PyObject(ObjectDescription[Tuple[str, str]]):
allow_nesting = False allow_nesting = False
def get_signature_prefix(self, sig: str) -> str: def get_signature_prefix(self, sig: str) -> List[nodes.Node]:
"""May return a prefix to put before the object name in the """May return a prefix to put before the object name in the
signature. signature.
""" """
return '' return []
def needs_arglist(self) -> bool: def needs_arglist(self) -> bool:
"""May return true if an empty argument list is to be generated even if """May return true if an empty argument list is to be generated even if
@ -482,7 +482,10 @@ class PyObject(ObjectDescription[Tuple[str, str]]):
sig_prefix = self.get_signature_prefix(sig) sig_prefix = self.get_signature_prefix(sig)
if sig_prefix: if sig_prefix:
if isinstance(sig_prefix, str):
signode += addnodes.desc_annotation(sig_prefix, sig_prefix) signode += addnodes.desc_annotation(sig_prefix, sig_prefix)
else:
signode += addnodes.desc_annotation(str(sig_prefix), '', *sig_prefix)
if prefix: if prefix:
signode += addnodes.desc_addname(prefix, prefix) signode += addnodes.desc_addname(prefix, prefix)