DOP-2620: Coalesce adjacent inline-in-block-context substitutions into a single paragraph

Author: i80and

snooty/postprocess.py

@@ -1165,8 +1165,23 @@ def search_block(
         if result is None:
             return None
 
-        # If we're injecting inline nodes, wrap them in a paragraph
-        return [n.Paragraph(node.span, [el]) if isinstance(el, n.InlineNode) else el for el in result]  # type: ignore
+        # If we're injecting inline nodes, wrap them in a paragraph. Coalesce adjacent
+        # inline elements into a single paragraph.
+        output: List[n.Node] = []
+        current_paragraph: List[n.InlineNode] = []
+        for element in result:
+            if isinstance(element, n.InlineNode):
+                current_paragraph.append(element)
+            else:
+                if current_paragraph:
+                    output.append(n.Paragraph(node.span, current_paragraph))  # type: ignore
+                    current_paragraph = []
+                output.append(element)
+
+        if current_paragraph:
+            output.append(n.Paragraph(node.span, current_paragraph))  # type: ignore
+
+        return output
 
     def _search(
         self,

snooty/test_postprocess.py

@@ -1581,6 +1581,58 @@ def test_replacements() -> None:
 """,
         )
 
+    # Test replacements that have multiple inline elements: DOP-2620
+    with make_test(
+        {
+            Path(
+                "source/index.txt"
+            ): """
+.. binary:: mongod
+
+.. |both| replace:: Available for :binary:`~bin.mongod` only.
+
+|both|
+
+"""
+        }
+    ) as result:
+        check_ast_testing_string(
+            result.pages[FileId("index.txt")].ast,
+            """
+<root fileid="index.txt">
+    <target domain="mongodb" name="binary" html_id="mongodb-binary-bin.mongod">
+        <directive_argument>
+            <literal>
+                <text>mongod</text>
+            </literal>
+        </directive_argument>
+        <target_identifier ids="['bin.mongod']">
+            <text>mongod</text>
+        </target_identifier>
+    </target>
+    <substitution_definition name="both">
+        <text>Available for </text>
+        <ref_role domain="mongodb" name="binary" target="bin.mongod" flag="~" fileid="['index', 'mongodb-binary-bin.mongod']">
+            <literal>
+                <text>mongod</text>
+            </literal>
+        </ref_role>
+        <text> only.</text>
+    </substitution_definition>
+    <substitution_reference name="both">
+        <paragraph>
+            <text>Available for </text>
+            <ref_role domain="mongodb" name="binary" target="bin.mongod" flag="~" fileid="['index', 'mongodb-binary-bin.mongod']">
+                <literal>
+                    <text>mongod</text>
+                </literal>
+            </ref_role>
+            <text> only.</text>
+        </paragraph>
+    </substitution_reference>
+</root>""",
+        )
+
 
 def test_replacements_scope() -> None:
     with make_test(