Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Filter based on class inheritance #106

Open
yi2020 opened this issue May 17, 2021 · 1 comment
Open

Filter based on class inheritance #106

yi2020 opened this issue May 17, 2021 · 1 comment
Labels
feature New feature or request

Comments

@yi2020
Copy link

yi2020 commented May 17, 2021

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 yi2020 added the feature New feature or request label May 17, 2021
@pawamoy
Copy link
Member

pawamoy commented Sep 17, 2021

Hello @yi2020, very sorry for the late answer 🙇

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 🙂

Stay tuned!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants