New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Overridden classmethod documentation not inherited with autodoc #9757
Comments
By default, autodoc searches the docstring from the parent class. Please disable |
Setting This to me seems like a bug specific to classmethods |
@tk0miya I don't think this issue is resolved |
Okay, I'll take a look. |
Sorry, I misunderstand your report. Reproduced the error on my local. |
Fix #9757: autodoc_inherit_docstrings does not effect to overriden classmethods
Describe the bug
The documentation for a classmethod in a parent class is not inherited by the method re-defined (without documentation) in a child class
How to Reproduce
Module
src/spam.py
:Sphinx configuration
docs/conf.py
:Documentation index
docs/index.rst
:Build:
Expected behavior
Overridden classmethod to inherit documentation from parent class
Your project
https://github.com/EpicWink/python-swf-typed
Screenshots
OS
Ubuntu 20.04
Python version
3.8
Sphinx version
4.2.0
Sphinx extensions
sphinx.ext.autodoc
Additional context
inspect.getdoc(Child.method)
returns the expected valueThe text was updated successfully, but these errors were encountered: