Skip to content

Inherit docstrings from Base to Derived Class #295

Open
@ktsitsi

Description

@ktsitsi

I have the case where multiple classes (Derived Classes) - which are implementations of a Base Class - do not inherit the docstrings of abstract functions and attributes of the latter. Although I looked it up I could not really find some option to enable it. I mostly need this cause in the general inheritance case I wouldn't want to make the code verbose with copies of the same docstring in the function & properties of each of the derived class.

Looking up the issues I found this one #224. But it does not quite fit my case.
I think that it should be sth similar to Sphinx's autodoc_inherit_docstrings = True

Metadata

Metadata

Assignees

No one assigned

    Projects

    Status

    Todo

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions