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, arglist

Browse Source
This commit is contained in:
Jakob Lykke Andersen 2021-09-25 12:17:24 +02:00
parent 92a9df7451
commit 3a1bd32665
2 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
sphinx/domains/python.py
View File

@ -228,13 +228,13 @@ def _parse_arglist(arglist: str, env: BuildEnvironment = None) -> addnodes.desc_
if param.annotation is not param.empty: if param.annotation is not param.empty:
children = _parse_annotation(param.annotation, env) children = _parse_annotation(param.annotation, env)
node += addnodes.desc_sig_punctuation('', ':') node += addnodes.desc_sig_punctuation('', ':')
node += nodes.Text(' ') node += addnodes.desc_sig_space()
node += addnodes.desc_sig_name('', '', *children) # type: ignore node += addnodes.desc_sig_name('', '', *children) # type: ignore
if param.default is not param.empty: if param.default is not param.empty:
if param.annotation is not param.empty: if param.annotation is not param.empty:
node += nodes.Text(' ') node += addnodes.desc_sig_space()
node += addnodes.desc_sig_operator('', '=') node += addnodes.desc_sig_operator('', '=')
node += nodes.Text(' ') node += addnodes.desc_sig_space()
else: else:
node += addnodes.desc_sig_operator('', '=') node += addnodes.desc_sig_operator('', '=')
node += nodes.inline('', param.default, classes=['default_value'], node += nodes.inline('', param.default, classes=['default_value'],

26
tests/test_domain_py.py
View File

@ -291,7 +291,7 @@ def test_parse_annotation(app):
[desc_sig_punctuation, "["], [desc_sig_punctuation, "["],
[pending_xref, "int"], [pending_xref, "int"],
[desc_sig_punctuation, ","], [desc_sig_punctuation, ","],
[desc_sig_space], desc_sig_space,
[pending_xref, "int"], [pending_xref, "int"],
[desc_sig_punctuation, "]"])) [desc_sig_punctuation, "]"]))
@ -307,7 +307,7 @@ def test_parse_annotation(app):
[desc_sig_punctuation, "["], [desc_sig_punctuation, "["],
[pending_xref, "int"], [pending_xref, "int"],
[desc_sig_punctuation, ","], [desc_sig_punctuation, ","],
[desc_sig_space], desc_sig_space,
[desc_sig_punctuation, "..."], [desc_sig_punctuation, "..."],
[desc_sig_punctuation, "]"])) [desc_sig_punctuation, "]"]))
@ -385,7 +385,7 @@ def test_pyfunction_signature(app):
assert_node(doctree[1][0][1], assert_node(doctree[1][0][1],
[desc_parameterlist, desc_parameter, ([desc_sig_name, "name"], [desc_parameterlist, desc_parameter, ([desc_sig_name, "name"],
[desc_sig_punctuation, ":"], [desc_sig_punctuation, ":"],
" ", desc_sig_space,
[nodes.inline, pending_xref, "str"])]) [nodes.inline, pending_xref, "str"])])
@ -403,7 +403,7 @@ def test_pyfunction_signature_full(app):
assert_node(doctree[1][0][1], assert_node(doctree[1][0][1],
[desc_parameterlist, ([desc_parameter, ([desc_sig_name, "a"], [desc_parameterlist, ([desc_parameter, ([desc_sig_name, "a"],
[desc_sig_punctuation, ":"], [desc_sig_punctuation, ":"],
" ", desc_sig_space,
[desc_sig_name, pending_xref, "str"])], [desc_sig_name, pending_xref, "str"])],
[desc_parameter, ([desc_sig_name, "b"], [desc_parameter, ([desc_sig_name, "b"],
[desc_sig_operator, "="], [desc_sig_operator, "="],
@ -411,28 +411,28 @@ def test_pyfunction_signature_full(app):
[desc_parameter, ([desc_sig_operator, "*"], [desc_parameter, ([desc_sig_operator, "*"],
[desc_sig_name, "args"], [desc_sig_name, "args"],
[desc_sig_punctuation, ":"], [desc_sig_punctuation, ":"],
" ", desc_sig_space,
[desc_sig_name, pending_xref, "str"])], [desc_sig_name, pending_xref, "str"])],
[desc_parameter, ([desc_sig_name, "c"], [desc_parameter, ([desc_sig_name, "c"],
[desc_sig_punctuation, ":"], [desc_sig_punctuation, ":"],
" ", desc_sig_space,
[desc_sig_name, pending_xref, "bool"], [desc_sig_name, pending_xref, "bool"],
" ", desc_sig_space,
[desc_sig_operator, "="], [desc_sig_operator, "="],
" ", desc_sig_space,
[nodes.inline, "True"])], [nodes.inline, "True"])],
[desc_parameter, ([desc_sig_name, "d"], [desc_parameter, ([desc_sig_name, "d"],
[desc_sig_punctuation, ":"], [desc_sig_punctuation, ":"],
" ", desc_sig_space,
[desc_sig_name, pending_xref, "tuple"], [desc_sig_name, pending_xref, "tuple"],
" ", desc_sig_space,
[desc_sig_operator, "="], [desc_sig_operator, "="],
" ", desc_sig_space,
[nodes.inline, "(1, 2)"])], [nodes.inline, "(1, 2)"])],
[desc_parameter, ([desc_sig_operator, "**"], [desc_parameter, ([desc_sig_operator, "**"],
[desc_sig_name, "kwargs"], [desc_sig_name, "kwargs"],
[desc_sig_punctuation, ":"], [desc_sig_punctuation, ":"],
" ", desc_sig_space,
[desc_sig_name, pending_xref, "str"])])]) [desc_sig_name, pending_xref, "str"])])])
@ -491,7 +491,7 @@ def test_pyfunction_with_union_type_operator(app):
assert_node(doctree[1][0][1], assert_node(doctree[1][0][1],
[desc_parameterlist, ([desc_parameter, ([desc_sig_name, "age"], [desc_parameterlist, ([desc_parameter, ([desc_sig_name, "age"],
[desc_sig_punctuation, ":"], [desc_sig_punctuation, ":"],
" ", desc_sig_space,
[desc_sig_name, ([pending_xref, "int"], [desc_sig_name, ([pending_xref, "int"],
desc_sig_space, desc_sig_space,
[desc_sig_punctuation, "|"], [desc_sig_punctuation, "|"],