-
-
Notifications
You must be signed in to change notification settings - Fork 43
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
feat: Add option to search for stubs packages #128
Conversation
This allows using the feature in griffe that searches for stubs packages Related: mkdocstrings/griffe#221
I think this should work. Will play with it a bit but wanted to open something so I don't forget. Hopefully it's as simple as this :). Let me know and happy to fix any issues. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice, thanks!
Are you planning to only use this config option along with preload_modules
? I suppose other users would want to use it directly, without having to specify other modules to preload? Then we should also add find_stubs_package=final_config["find_stubs_package"]
to the next line (285 here).
Could you also add an entry in the documentation? In docs/usage/configuration/general.md
. No need for previews here, just an explanation of what this does, with file layouts (you can use tree
fences).
I can also take it from here if you don't have the capacity 🙂
Oops, I want to use it in line 285 so yes, I will add it there directly as well (that was an omission). I'll look for the doc and add it. No problem. Thanks for taking a look. I'll do this tonight. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, looking good!
This allows using the feature in Griffe that searches for stubs packages. PR #128: mkdocstrings/python#128 PR griffe#221: : mkdocstrings/griffe#221
This allows using the feature in griffe that searches for stubs packages
Related: mkdocstrings/griffe#221