mkdocstrings / python

A Python handler for mkdocstrings.
https://mkdocstrings.github.io/python
ISC License
190 stars 35 forks source link

feature: Filter shown base classes #161

Open lars-reimann opened 6 months ago

lars-reimann commented 6 months ago

Is your feature request related to a problem? Please describe.

There is already an option show_bases to fully enable or disable whether base classes are shown. I'd like to be able to hide only internal base classes (name starts with an underscore) but still show the others.

Describe the solution you'd like

An option to filter which base classes are displayed. Maybe the existing filters option could be applied to base classes as well.

Describe alternatives you've considered

Additional context

This is especially useful when inherited_members is set to true.

Also thanks for the awesome tool, it's a joy to use.

pawamoy commented 6 months ago

Hello, thanks for the feature request! I agree that it would make sense to filter shown bases in accordance with filters :thinking: Let me think about it a bit more.