sphinx.ext.napoleon: Don't indent empty lines

Signed-off-by: Stephen Finucane <[email protected]>

Author: stephenfin

sphinx/ext/napoleon/docstring.py

@@ -534,7 +534,7 @@ def _get_min_indent(self, lines: list[str]) -> int:
         return min_indent or 0
 
     def _indent(self, lines: list[str], n: int = 4) -> list[str]:
-        return [(' ' * n) + line for line in lines]
+        return [(' ' * n) + line if line else line for line in lines]
 
     def _is_indented(self, line: str, indent: int = 1) -> bool:
         for i, s in enumerate(line):  # noqa: SIM110

tests/test_ext_napoleon_docstring.py

@@ -397,13 +397,11 @@ def test_sphinx_admonitions(self):
             # Multiline
             actual = str(GoogleDocstring(f"{section}:\n"
                                          "    this is the first line\n"
-                                         "\n"
                                          "    and this is the second line\n",
                                          config))
             expect = (f".. {admonition}::\n"
                       "\n"
                       "   this is the first line\n"
-                      "   \n"
                       "   and this is the second line\n"
                       )
             assert expect == actual
@@ -1154,7 +1152,7 @@ def test_noindex(self):
 .. method:: func(i, j)
    :no-index:
 
-   
+
    description
 """  # noqa: W293
         config = Config()
@@ -1459,13 +1457,11 @@ def test_sphinx_admonitions(self):
             actual = str(NumpyDocstring(f"{section}\n"
                                         f"{'-' * len(section)}\n"
                                         "    this is the first line\n"
-                                        "\n"
                                         "    and this is the second line\n",
                                         config))
             expect = (f".. {admonition}::\n"
                       "\n"
                       "   this is the first line\n"
-                      "   \n"
                       "   and this is the second line\n"
                       )
             assert expect == actual
@@ -1610,7 +1606,7 @@ def test_see_also_refs(self):
 .. seealso::
 
    :obj:`some`, :obj:`other`, :obj:`funcs`
-   \n\
+
    :obj:`otherfunc`
        relationship
 """
@@ -1636,7 +1632,7 @@ def test_see_also_refs(self):
 .. seealso::
 
    :obj:`some`, :obj:`other`, :obj:`funcs`
-   \n\
+
    :obj:`otherfunc`
        relationship
 """
@@ -1665,7 +1661,7 @@ def test_see_also_refs(self):
 .. seealso::
 
    :obj:`some`, :obj:`MyClass.other`, :func:`funcs`
-   \n\
+
    :func:`~my_package.otherfunc`
        relationship
 """