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

always use separate fields for param and type in ext.autodoc.typehints

Browse Source 
this fixes issues where annotations such as `x: typing.Tuple[int, int]`
will be transformed to `:field typing.Tuple[int, int] x:`, which renders
as `*int] x* (**typing.Tuple[int,**) -- `
This commit is contained in:
Kjell Braden 2020-04-26 20:09:43 +02:00 committed by Takeshi KOMIYA
parent d47427e94f
commit 4877a7594c
1 changed files with 6 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
sphinx/ext/autodoc/typehints.py
View File

@ -104,24 +104,16 @@ def modify_field_list(node: nodes.field_list, annotations: Dict[str, str]) -> No
continue
arg = arguments.get(name, {})
field = nodes.field()
if arg.get('param') and arg.get('type'):
# both param and type are already filled manually
continue
elif arg.get('param'):
# only param: fill type field
if not arg.get('type'):
field = nodes.field()
field += nodes.field_name('', 'type ' + name)
field += nodes.field_body('', nodes.paragraph('', annotation))
elif arg.get('type'):
# only type: It's odd...
node += field
if not arg.get('param'):
field = nodes.field()
field += nodes.field_name('', 'param ' + name)
field += nodes.field_body('', nodes.paragraph('', ''))
else:
# both param and type are not found
field += nodes.field_name('', 'param ' + annotation + ' ' + name)
field += nodes.field_body('', nodes.paragraph('', ''))
node += field
node += field
if 'return' in annotations and 'return' not in arguments:
field = nodes.field()