-
-
Notifications
You must be signed in to change notification settings - Fork 72
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
Add NumPy Docstring Style Support #52
Comments
Maybe one could make use of mktheapidocs plugin from Mkdocs plugins list |
@TejasAvinashShetty have you managed to get that working? I tried it, but don't think I configured things quite correctly. |
Nope, I have not tried it yet. I just suggested it as a quick fix. Hopefully, when I get time I will try it out. |
|
@timothycrosley @kylebarron @sanzoghenzo This is possible to solve once this is merged. However, portray is using it's own Is it possible to make |
I see that @timothycrosley is this an intended feature, or can this be merged in |
Following up to link the work @sanzoghenzo and @kylebarron did on pdocs that adds the mentioned I suppose the last step is relying on pdocs' own |
I didn't test it, but I think all that is needed is to remove the text.mako file and this line, so that portray doesn't force the default template and pdocs uses its own. |
@sanzoghenzo I monkey patched it locally and it seems to work by deleting that line and the default text.mako. At least for very simple documentations mixing several docstring styles produced no errors and looked clean to me. |
Just as discussed in #47 with the Google Docstring format, it would be great to have support for NumPy Docstrings; An example of which can be found here.
The text was updated successfully, but these errors were encountered: