Merge pull request #833 from jakobandersen/fix-literal-in-paragraph

Pull lone literal_blocks out of paragraphs

CHANGELOG.rst

@@ -3,6 +3,11 @@ Change Log
 
 Inspired by `Keepachangelog.com <http://keepachangelog.com/>`__.
 
+- Unreleased
+
+  - Pull lone literal blocks in paragraphs up to produce correct doctree.
+    `#833 <https://github.com/michaeljones/breathe/pull/833>`__
+
 - 2022-06-20 - **Breathe v4.34.0**
 
   - Treat .unparsed as plain text.

breathe/renderer/sphinxrenderer.py

@@ -1502,6 +1502,23 @@ def visit_docpara(self, node) -> List[Node]:
             nodelist.extend(paramList)
             nodelist.extend(fields)
 
+        # And now all kinds of cleanup steps
+        # ----------------------------------
+
+        # trim trailing whitespace
+        while len(nodelist) != 0:
+            last = nodelist[-1]
+            if not isinstance(last, nodes.Text):
+                break
+            if last.astext().strip() != "":
+                break
+            nodelist.pop()
+
+        # https://github.com/michaeljones/breathe/issues/827
+        # verbatim nodes should not be in a paragraph:
+        if len(nodelist) == 1 and isinstance(nodelist[0], nodes.literal_block):
+            return nodelist
+
         return [nodes.paragraph("", "", *nodelist)]
 
     def visit_docparblock(self, node) -> List[Node]: