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

treat value sets as literals

Browse Source
This commit is contained in:
Keewis 2020-05-29 21:16:49 +02:00
parent e3b7e16b0a
commit 20e36007fe
1 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -845,14 +845,17 @@ def _convert_numpy_type_spec(_type, translations={}):
def token_type(token):
if token.startswith(" ") or token.endswith(" "):
type_ = "delimiter"
elif token.startswith("{") and token.endswith("}"):
type_ = "value_set"
elif (
token.isnumeric()
or (token.startswith("{") and token.endswith("}"))
or (token.startswith('"') and token.endswith('"'))
or (token.startswith("'") and token.endswith("'"))
):
type_ = "literal"
elif token in ("optional", "default"):
type_ = "control"
elif _xref_regex.match(token):
type_ = "reference"
elif token.isnumeric() or (token.startswith('"') and token.endswith('"')):
type_ = "literal"
else:
type_ = "obj"
@ -875,7 +878,6 @@ def _convert_numpy_type_spec(_type, translations={}):
)
converters = {
"value_set": lambda x: f"``{x}``",
"literal": lambda x: f"``{x}``",
"obj": lambda x: convert_obj(x, translations, default_translation),
"control": lambda x: f"*{x}*",