-
-
Notifications
You must be signed in to change notification settings - Fork 31
feat: Add support for Numpy docstrings #87
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 support for Numpy docstrings #87
Conversation
CI is failing given that mkdocs is a dependency of pytkdocs and requires a version number lower than the current one ( Maybe mkdocstrings should relax the versio number requirements ? |
I just upgraded mkdocstrings version in pyproject.toml to 0.14.0, which accepts pytkdocs <0.11. You can rebase on master to see how CI behaves now. |
b84d6ad
to
ab71d8d
Compare
Ok the CI is passing now ! |
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.
Alright, looking good 🙂
Just a few nitpicks, and the new dependency should be made optional!
Thanks a lot 🙂
Co-authored-by: Timothée Mazzucotelli <[email protected]>
Co-authored-by: Timothée Mazzucotelli <[email protected]>
…ncluded in the docstring
I've tried to address all the comments. CI quality is failing for some reason (it didn't with |
Hello, did you have the time to review this PR ? Is there anything that can still be improved ? |
Hi @aschmu, sorry for the delay! Thanks for addressing the previous comments! I've added a couple more. One of them could resolve the CI failure. If not I'll merge anyway, must simply be a CI cache issue 🙂 |
Merci Achille 😄 ! |
This is an initial stab at supporting numpy style docstrings. The
docstring_parser
library is used, therefore not all errors are caught but I still think it's useful especially since the objective is to enable mkdocs to automatically document functions with themkdocstrings
plugin.Speaking of
mkdocstrings
, I couldn't quite figure out how to switch (package-wide) to a different docstring style from the documentation 🤔 .Fixes #7