machow / quartodoc

Generate API documentation with quarto

Home Page:https://machow.github.io/quartodoc

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Inherit docstrings from Base to Derived Class

ktsitsi opened this issue · comments

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

Hey, thanks for raising this! There is some discussion on mkdocstrings/griffe#96 about adding this functionality to griffe, the tool we use to find python objects.

I think we should have everything to add an inherit_docstrings option to quartodoc, but haven't implemented yet.

edit: linking to the sphinx code so it's easy to find later