fix: Keep newlines in parameter (and other multiline directives) descriptions in Sphinx docstrings

Issue-mkdocstrings-808: mkdocstrings/mkdocstrings#808

Author: pawamoy

src/griffe/_internal/docstrings/sphinx.py

@@ -10,6 +10,7 @@
 from dataclasses import dataclass, field
 from typing import TYPE_CHECKING, Any, Callable, TypedDict
 from warnings import warn
+from inspect import cleandoc
 
 from griffe._internal.docstrings.models import (
     DocstringAttribute,
@@ -466,10 +467,10 @@ def _consolidate_continuation_lines(lines: list[str], offset: int) -> tuple[str,
     # start processing after first item
     curr_line_index += 1
     while curr_line_index < len(lines) and not lines[curr_line_index].startswith(":"):
-        block.append(lines[curr_line_index].lstrip())
+        block.append(lines[curr_line_index])
         curr_line_index += 1
 
-    return " ".join(block).rstrip("\n"), curr_line_index - 1
+    return cleandoc("\n".join(block)).rstrip("\n"), curr_line_index - 1
 
 
 def _consolidate_descriptive_type(descriptive_type: str) -> str:

tests/test_docstrings/test_sphinx.py

@@ -190,7 +190,7 @@ def test_parse__param_field_multi_line__param_section(parse_sphinx: ParserType,
     assert len(sections) == 2
     assert sections[1].kind is DocstringSectionKind.parameters
     actual = sections[1].value[0]
-    expected = DocstringParameter(SOME_NAME, description=f"{SOME_TEXT} {SOME_EXTRA_TEXT}")
+    expected = DocstringParameter(SOME_NAME, description=f"{SOME_TEXT}\n{SOME_EXTRA_TEXT}")
     assert isinstance(actual, type(expected))
     assert actual.as_dict() == expected.as_dict()
 
@@ -747,6 +747,53 @@ def test_parse__param_type_no_name__error_message(parse_sphinx: ParserType) -> N
     assert "Failed to get parameter name from" in warnings[0]
 
 
+def test_parse__param_multiline(parse_sphinx: ParserType) -> None:
+    """Parse multiline parameter descriptions.
+
+    Parameters:
+        parse_sphinx: Fixture parser.
+    """
+    docstring = """Do something.
+
+        :param foo: This is a docstring that is long enough to run onto a second line,
+            because it is quite long.
+
+            A second paragraph is also required.
+        :param bar: This is an example that is quite long, and also requires bullet
+            points to be clear about intent:
+
+            * First thing
+
+                ```
+                a code block
+                ```
+
+            * Second thing
+            * Third thing
+    """
+
+    sections, _ = parse_sphinx(docstring)
+    param_section = sections[1]
+
+    param_foo = param_section.value[0]
+    assert param_foo.description == (
+        "This is a docstring that is long enough to run onto a second line,\n"
+        "because it is quite long.\n\n"
+        "A second paragraph is also required."
+    )
+
+    param_bar = param_section.value[1]
+    assert param_bar.description == (
+        "This is an example that is quite long, and also requires bullet\n"
+        "points to be clear about intent:\n\n"
+        "* First thing\n\n"
+        "    ```\n"
+        "    a code block\n"
+        "    ```\n\n"
+        "* Second thing\n"
+        "* Third thing"
+    )
+
 @pytest.mark.parametrize(
     "docstring",
     [
@@ -775,7 +822,7 @@ def test_parse__attribute_field_multi_line__param_section(parse_sphinx: ParserTy
     assert len(sections) == 2
     assert sections[1].kind is DocstringSectionKind.attributes
     actual = sections[1].value[0]
-    expected = DocstringAttribute(SOME_NAME, description=f"{SOME_TEXT} {SOME_EXTRA_TEXT}")
+    expected = DocstringAttribute(SOME_NAME, description=f"{SOME_TEXT}\n{SOME_EXTRA_TEXT}")
     assert isinstance(actual, type(expected))
     assert actual.as_dict() == expected.as_dict()
     assert not warnings