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

don't use the obj role if it is not necessary

Browse Source
This commit is contained in:
Keewis 2020-05-22 19:27:14 +02:00
parent ace933107a
commit 8ab210f1b0
1 changed files with 10 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
sphinx/ext/napoleon/docstring.py
View File

@ -842,8 +842,8 @@ def _parse_numpy_type_spec(_type):
return type_
def convert_obj(obj, translations):
return translations.get(obj, ":obj:`{}`".format(obj))
def convert_obj(obj, translations, default_translation=":obj:`{}`"):
return translations.get(obj, default_translation.format(obj))
tokens = tokenize_type_spec(_type)
types = [
@ -858,10 +858,17 @@ def _parse_numpy_type_spec(_type):
"dict-like": ":term:`dict-like <mapping>`",
}
# don't use the object role if it's not necessary
default_translation = (
":obj:`{}`"
if not all(type_ == "obj" for _, type_ in types)
else "{}"
)
converters = {
"value_set": lambda x: f":noref:`{x}`",
"literal": lambda x: f":noref:`{x}`",
"obj": lambda x: convert_obj(x, translations),
"obj": lambda x: convert_obj(x, translations, default_translation),
"control": lambda x: f":noref:`{x}`",
"delimiter": lambda x: x,
"reference": lambda x: x,