readthedocs / sphinx-autoapi

A new approach to API documentation in Sphinx.
https://sphinx-autoapi.readthedocs.io/
MIT License
415 stars 126 forks source link

Anybody having issues with numpydoc? #421

Open HealthyPear opened 4 months ago

HealthyPear commented 4 months ago

Not sure who is at fault here (maybe me!), but I am using sphinx-autoapi with numpydoc validations activated via sphinx and I get lots of warnings like

WARNING: [numpydoc] Validation warnings while processing docstring for 'my_function':
  GL08: The object does not have a docstring

actually, not a lot: all of them.

Of course, I checked and they totally have them, I can even check that is true by doing e.g.

python -m numpydoc --validate my_package.my_module.my_function.

Did anybody encounter this weird issue or is it just me?