Inherited menber

[samsja]

Context

Hey, first thanks for the great tools!

I commented recently on this issue in pytkdocs.

My end goal is to make work the inherited_members of mkdocstring work.

I was about to create a PR for pytkdocs but I saw that the new python handler of mkdostring is using griffe.

So I was wondering :

• is ìnherited_menbers` or something similar is implemented on griffe ?
• If no, I will try to draft a PR to fix it (as I really need to be able to show inherited method for my project), where should I start ?

Thanks in advance

[pawamoy]

Hello! Thanks for your help!

Erm, I had started working on it but can't find my local branch anymore... probably on another computer. Will let you know 🙂

[samsja]

Great then !

[pawamoy]

So, I never found the branch I was talking about, hahaha... 💀
It contained only one or two functions, so it's fine, I'll just start again. Let me gather my thoughts again, and I'll report back, so that you can help, if needed and if you're still willing to 🙂

[samsja]

I would be happy to do this PR. I found a hack on my side which is why I did not spend much time on this for now

[pawamoy]

Quick question: how would you then render inherited members in your docs?

Like this?

::: path.to.my.Class
    options:
      inherited_members: true

Or would you like to reference specific inherited members, like this?

::: path.to.my.Class.inherited_method

[samsja]

sorry I did not had time to answer. The first one seems more natural to me. But both looks fine honestly

[pawamoy]

Thanks! Yeah I've made it work in both cases anyway 🙂
It was pretty much guaranteed that users would want to access inherited members this way (second snippet).
It was a bit hard to pull off, but I managed to do that in a clean way 🙂