Skip to content

Warning: autosummary: stub file not found #290

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

Closed
egbuck opened this issue Aug 1, 2020 · 3 comments
Closed

Warning: autosummary: stub file not found #290

egbuck opened this issue Aug 1, 2020 · 3 comments

Comments

@egbuck
Copy link

egbuck commented Aug 1, 2020

I made a stackoverflow post about this, which tracked the problem back to numpydoc.

It may be user error, but it appears that this warning will get thrown when I use numpydoc, but not if I use the sphinx.ext.napolean extension. I've read all of the numpydoc documentation, I have a current version of sphinx, and I've tried setting autosummary_generate = True like the warning message suggests.

Perhaps I'm not using an option of numpydoc that I should be - I'm not sure. Or perhaps this is a bug with how numpydoc is integrated with autosummary.

@jnothman
Copy link
Member

jnothman commented Aug 1, 2020

Please provide an example collection of files that reproduces your issue.

@egbuck
Copy link
Author

egbuck commented Aug 2, 2020

I attached the relevant files here

Please don't judge my horrible code too harshly - was just trying to showcase the docstring issue I was running into.

ref_docs.zip

@egbuck
Copy link
Author

egbuck commented Aug 2, 2020

A commenter in the stack overflow post said my files did not generate any warnings for them - thus, I believe it must be something wrong with my machine's configuration or something else I'm doing wrong. I'm closing the issue as a result.

@egbuck egbuck closed this as completed Aug 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants