pytkdocs icon indicating copy to clipboard operation
pytkdocs copied to clipboard

Filter based on class inheritance

Open yi2020 opened this issue 4 years ago • 1 comments

Is your feature request related to a problem? Please describe. I'm documenting a package but I only care about classes of certain types. Specifically, those that inherit (directly, or indirectly) from a specific class (we call the top-level one Mergeable). I don't want to document the other classes.

Describe the solution you'd like A filter that is class based. Ideally, we can expand the filters to take more factors into account, like if something is a dataclass.

Describe alternatives you've considered I tried using the name-based filter, but it's not a fit for this.

yi2020 avatar May 17 '21 17:05 yi2020

Hello @yi2020, very sorry for the late answer :bow:

I'm working on a new tool to replace pytkdocs (which is very limited by design). This new tool will make it easy to write extensions. An extension that can be configured to prune objects (like classes that do not inherit from a Mergeable class) is something that will be possible to write :slightly_smiling_face:

Stay tuned!

pawamoy avatar Sep 17 '21 21:09 pawamoy