Describe the bug
The documentation for the autodoc-skip-member event is incorrect in at least 2 ways.
- It says that the
obj_type is "the type of the object which the docstring belongs to." It is actually the type of the enclosing "container"—module, class, exception, etc.
- It says that the
name is the fully qualified name of the object. It is actually the unqualified name of the object.
How to Reproduce
Add the following to conf.py.
def skip_member_log(app, what, name, obj, skip, options):
print(f'SKIP-MEMBER: what = {what}, name = {name}')
return skip
def setup(app):
app.connect('autodoc-skip-member', skip_member_log)
Run Sphinx (with the autodoc extension enabled against this class.
Note the following output.
SKIP-MEMBER: what = class, name = bar
The obj_type (what) argument is 'class' (the type of Foo, not the type of bar), and the name is not fully qualified.
Environment Information
Platform: linux; (Linux-7.1.4-200.fc44.x86_64-x86_64-with-glibc2.43)
Python version: 3.14.6 (main, Jun 11 2026, 00:00:00) [GCC 16.1.1 20260515 (Red Hat 16.1.1-2)])
Python implementation: CPython
Sphinx version: 9.1.0
Docutils version: 0.22.4
Jinja2 version: 3.1.6
Pygments version: 2.19.1
Sphinx extensions
extensions = [
'sphinx.ext.autodoc', 'sphinx.ext.autosummary', 'sphinx.ext.napoleon'
]
Additional context
No response
Describe the bug
The documentation for the
autodoc-skip-memberevent is incorrect in at least 2 ways.obj_typeis "the type of the object which the docstring belongs to." It is actually the type of the enclosing "container"—module,class,exception, etc.nameis the fully qualified name of the object. It is actually the unqualified name of the object.How to Reproduce
Add the following to
conf.py.Run Sphinx (with the
autodocextension enabled against this class.Note the following output.
The
obj_type(what) argument is'class'(the type ofFoo, not the type ofbar), and the name is not fully qualified.Environment Information
Sphinx extensions
Additional context
No response