diff options
| author | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2018-09-29 21:12:40 +0900 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-09-29 21:12:40 +0900 |
| commit | 973c3ffa25f6f14e53382f7a45ffbeee9d252b3c (patch) | |
| tree | d4d500f2dad3bbdab82820f1f4bb2ae5bc97a6ff /sphinx/util/docfields.py | |
| parent | abcb5bd5eca6ea46ffcc34a55b663083d03f339c (diff) | |
| parent | d2c3d54bb9a46c5e7a0d14c3345e489d7592de9a (diff) | |
| download | sphinx-git-973c3ffa25f6f14e53382f7a45ffbeee9d252b3c.tar.gz | |
Merge branch 'master' into change_master_doc_to_index
Diffstat (limited to 'sphinx/util/docfields.py')
| -rw-r--r-- | sphinx/util/docfields.py | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/sphinx/util/docfields.py b/sphinx/util/docfields.py index 202616337..d0899130e 100644 --- a/sphinx/util/docfields.py +++ b/sphinx/util/docfields.py @@ -36,7 +36,7 @@ def _is_single_paragraph(node): return False -class Field(object): +class Field: """A doc field that is never grouped. It can have an argument or not, the argument can be linked using a specified *rolename*. Field should be used for doc fields that usually don't occur more than once. @@ -235,7 +235,7 @@ class TypedField(GroupedField): return nodes.field('', fieldname, fieldbody) -class DocFieldTransformer(object): +class DocFieldTransformer: """ Transforms field lists in "doc field" syntax into better-looking equivalents, using the field type definitions given on a domain. @@ -305,7 +305,8 @@ class DocFieldTransformer(object): entries.append(field) # but if this has a type then we can at least link it - if typedesc and is_typefield and content: + if (typedesc and is_typefield and content and + len(content) == 1 and isinstance(content[0], nodes.Text)): target = content[0].astext() xrefs = typedesc.make_xrefs( typedesc.typerolename, @@ -318,7 +319,8 @@ class DocFieldTransformer(object): fieldbody.children[0].extend(xrefs) else: fieldbody.clear() - fieldbody.extend(xrefs) + fieldbody += nodes.paragraph() + fieldbody[0].extend(xrefs) continue |