Only ignore class methods (no obvious use case for funcs/classes)

lukelbd · lukelbd · commit 50b9e1b48bf1 · 2020-05-24T18:58:54.000-06:00
diff --git a/sphinx_automodapi/automodapi.py b/sphinx_automodapi/automodapi.py
@@ -59,10 +59,9 @@
 
     * ``:ignore-emptydoc:`` or ``:no-ignore-emptydoc:``
         The global sphinx configuration option ``automodsumm_ignore_emptydoc``
-        decides if functions, classes, and class methods with empty
-        ``__doc__`` attributes are included in the generated documentation. The flags
-        ``:ignore-emptydoc:`` or ``:no-ignore-emptydoc:`` allow the user to override
-        the global setting.
+        decides if class methods with empty ``__doc__`` attributes are included
+        in the generated documentation. The flags ``:ignore-emptydoc:`` or
+        ``:no-ignore-emptydoc:`` allow the user to override the global setting.
 
 
 This extension also adds four sphinx configuration options:
@@ -333,15 +332,15 @@ def automodapi_replace(sourcestr, app, dotoctree=True, docname=None,
                 clsfuncoptions.append(':skip: ' + ','.join(toskip))
             if allowedpkgnms:
                 clsfuncoptions.append(allowedpkgnms)
-            if ignore_emptydoc is True:
-                clsfuncoptions.append(':ignore-emptydoc:')
-            if ignore_emptydoc is False:
-                clsfuncoptions.append(':no-ignore-emptydoc:')
             if hascls:  # This makes no sense unless there are classes.
                 if inherited_members is True:
                     clsfuncoptions.append(':inherited-members:')
                 if inherited_members is False:
                     clsfuncoptions.append(':no-inherited-members:')
+                if ignore_emptydoc is True:
+                    clsfuncoptions.append(':ignore-emptydoc:')
+                if ignore_emptydoc is False:
+                    clsfuncoptions.append(':no-ignore-emptydoc:')
             clsfuncoptionstr = '\n    '.join(clsfuncoptions)
 
             if hasfuncs:
diff --git a/sphinx_automodapi/automodsumm.py b/sphinx_automodapi/automodsumm.py
@@ -48,10 +48,9 @@
 
     * ``:ignore-emptydoc:`` or ``:no-ignore-emptydoc:``
         The global sphinx configuration option ``automodsumm_ignore_emptydoc``
-        decides if functions, classes, and class methods with empty
-        ``__doc__`` attributes are included in the generated documentation. The flags
-        ``:ignore-emptydoc:`` or ``:no-ignore-emptydoc:`` allows overrriding this
-        global setting.
+        decides if class methods with empty ``__doc__`` attributes are included
+        in the generated documentation. The flags ``:ignore-emptydoc:`` or
+        ``:no-ignore-emptydoc:`` allows overrriding this global setting.
 
 This extension also adds three sphinx configuration options:
 
@@ -70,11 +69,10 @@ class members that are inherited from a base class. This value can be
     ``False``.
 
 * ``automodsumm_ignore_emptydoc``
-    Should be a bool, and if ``True``, will cause `automodsumm`_ to ignore
-    functions, classes, and class methods with empty ``__doc__`` attributes.
-    This value can be overridden for any particular automodsumm directive by including
-    the ``:ignore-emptydoc:`` or ``:no-ignore-emptydoc:`` options. Defaults to
-    ``False``.
+    Should be a bool, and if ``True``, will cause `automodsumm`_ to ignore class
+    methods with empty ``__doc__`` attributes. This value can be overridden for any
+    particular automodsumm directive by including the ``:ignore-emptydoc:`` or
+    ``:no-ignore-emptydoc:`` options. Defaults to ``False``.
 
 .. _sphinx.ext.autosummary: http://sphinx-doc.org/latest/ext/autosummary.html
 .. _autosummary: http://sphinx-doc.org/latest/ext/autosummary.html#directive-autosummary
@@ -577,7 +575,7 @@ def get_members_class(obj, typ, include_public=[],
                         continue
                     if (
                         ignore_emptydoc
-                        and documenter.objtype in ('method', 'class', 'function')
+                        and documenter.objtype == 'method'
                         and not getattr(safe_getattr(obj, name), '__doc__', '')
                     ):
                         continue
