Merge pull request #7583 from eric-wieser/fix-napoleon

ext.napoleon: Emit type annotations at the start of `.. attribute::`

sphinx/ext/napoleon/__init__.py

@@ -168,11 +168,10 @@ class Config:
         **If False**::
 
             .. attribute:: attr1
+               :type: int
 
                Description of `attr1`
 
-               :type: int
-
     napoleon_use_param : :obj:`bool` (Defaults to True)
         True to use a ``:param:`` role for each function parameter. False to
         use a single ``:parameters:`` role for all the parameters.

sphinx/ext/napoleon/docstring.py

@@ -588,13 +588,12 @@ class GoogleDocstring:
                 lines.append('.. attribute:: ' + _name)
                 if self._opt and 'noindex' in self._opt:
                     lines.append('   :noindex:')
+                if _type:
+                    lines.extend(self._indent([':type: %s' % _type], 3))
                 lines.append('')
 
                 fields = self._format_field('', '', _desc)
                 lines.extend(self._indent(fields, 3))
-                if _type:
-                    lines.append('')
-                    lines.extend(self._indent([':type: %s' % _type], 3))
                 lines.append('')
         if self._config.napoleon_use_ivar:
             lines.append('')

tests/test_ext_napoleon_docstring.py

@@ -53,22 +53,19 @@ class NamedtupleSubclassTest(BaseDocstringTest):
 Sample namedtuple subclass
 
 .. attribute:: attr1
+   :type: Arbitrary type
 
    Quick description of attr1
 
-   :type: Arbitrary type
-
 .. attribute:: attr2
+   :type: Another arbitrary type
 
    Quick description of attr2
 
-   :type: Another arbitrary type
-
 .. attribute:: attr3
+   :type: Type
 
    Adds a newline after the type
-
-   :type: Type
 """
 
         self.assertEqual(expected, actual)
@@ -412,10 +409,9 @@ Attributes:
         actual = str(GoogleDocstring(docstring))
         expected = """\
 .. attribute:: in_attr
+   :type: :class:`numpy.ndarray`
 
    super-dooper attribute
-
-   :type: :class:`numpy.ndarray`
 """
         self.assertEqual(expected, actual)
 
@@ -427,10 +423,9 @@ Attributes:
         actual = str(GoogleDocstring(docstring))
         expected = """\
 .. attribute:: in_attr
+   :type: numpy.ndarray
 
    super-dooper attribute
-
-   :type: numpy.ndarray
 """
         self.assertEqual(expected, actual)