From b51ad6f159e0017506e23b15e58c1fecd634604a Mon Sep 17 00:00:00 2001 From: Gerard Marull-Paretas Date: Fri, 1 Oct 2021 10:22:26 +0200 Subject: [PATCH] renderer: use retval type for the retval fields This change makes @retval fields to render as a separate list, independent of the @return/s entries. Signed-off-by: Gerard Marull-Paretas --- breathe/renderer/sphinxrenderer.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/breathe/renderer/sphinxrenderer.py b/breathe/renderer/sphinxrenderer.py index 60ba9549..84c4b08d 100644 --- a/breathe/renderer/sphinxrenderer.py +++ b/breathe/renderer/sphinxrenderer.py @@ -896,7 +896,7 @@ def pullup(node, typ, dest): fieldLists = [fieldList] # collapse retvals into a single return field - if len(fieldLists) != 0: + if len(fieldLists) != 0 and sphinx.version_info[0:2] < (4, 3): others: nodes.field = [] retvals: nodes.field = [] for f in fieldLists[0]: @@ -2211,7 +2211,8 @@ def visit_docparamlist(self, node) -> List[Node]: "param": "param", "exception": "throws", "templateparam": "tparam", - "retval": "returns", + # retval support available on Sphinx >= 4.3 + "retval": "returns" if sphinx.version_info[0:2] < (4, 3) else "retval", } # https://docutils.sourceforge.io/docs/ref/doctree.html#field-list