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 <[email protected]>
breathe-doc · Oct 4, 2021 · b51ad6f · b51ad6f
1 parent 327374d
commit b51ad6f
Showing 1 changed file with 3 additions and 2 deletions.
diff --git 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