Autodoc: Pass namespace to skip-member callback

sphinx-doc · Oct 9, 2015 · 3926e1b · 3926e1b
1 parent 19f9c9f
commit 3926e1b
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 7 deletions.
diff --git a/sphinx/ext/autodoc.py b/sphinx/ext/autodoc.py
@@ -810,7 +810,7 @@ def filter_members(self, members, want_all):
                 # let extensions preprocess docstrings
                 skip_user = self.env.app.emit_firstresult(
                     'autodoc-skip-member', self.objtype, membername, member,
-                    not keep, self.options)
+                    self.fullname, not keep, self.options)
                 if skip_user is not None:
                     keep = not skip_user
 

diff --git a/sphinx/ext/napoleon/__init__.py b/sphinx/ext/napoleon/__init__.py
@@ -307,7 +307,7 @@ def _process_docstring(app, what, name, obj, options, lines):
     lines[:] = result_lines[:]
 
 
-def _skip_member(app, what, name, obj, skip, options):
+def _skip_member(app, what, name, obj, namespace, skip, options):
     """Determine if private and special class members are included in docs.
 
     The following settings in conf.py determine if private and special class

diff --git a/tests/test_autodoc.py b/tests/test_autodoc.py
@@ -93,7 +93,7 @@ def process_signature(app, what, name, obj, options, args, retann):
         return '42', None
 
 
-def skip_member(app, what, name, obj, skip, options):
+def skip_member(app, what, name, obj, namespace, skip, options):
     if name in ('__special1__', '__special2__'):
         return skip
     if name.startswith('_'):

diff --git a/tests/test_ext_napoleon.py b/tests/test_ext_napoleon.py
@@ -128,13 +128,13 @@ def assertSkip(self, what, member, obj, expect_skip, config_name):
         app.config = Config()
         setattr(app.config, config_name, True)
         if expect_skip:
-            self.assertEqual(skip, _skip_member(app, what, member, obj, skip,
-                                                mock.Mock()))
+            self.assertEqual(skip, _skip_member(app, what, member, obj, '',
+                                                skip, mock.Mock()))
         else:
-            self.assertFalse(_skip_member(app, what, member, obj, skip,
+            self.assertFalse(_skip_member(app, what, member, obj, '', skip,
                                           mock.Mock()))
         setattr(app.config, config_name, False)
-        self.assertEqual(skip, _skip_member(app, what, member, obj, skip,
+        self.assertEqual(skip, _skip_member(app, what, member, obj, '', skip,
                                             mock.Mock()))
 
     def test_namedtuple(self):