Search code examples
python-sphinxread-the-docssphinx-napoleon

How do I fix autoapi.not_readable error that only occurs on readthedocs?


I am getting an error on every one of my package files when I try to build my documentation on readthedocs. The error is [autoapi.not_readable].

The most strange part of this is that my documentation was previously building with no issues. I even tried to just rebuild a previous docs build that hasn't had any changes to it, and I'm getting this error now. The error is challenging to debug because it does not occur on my local machine.

I have tried chmod -R a+r . to made sure all files and folders have readable permissions, but this doesn't help. Looking for advice on what else to try??

I tried changing read permissions, I tried installing my package in editable mode, and I even just tried to rebuild a previously successful build without any changes. No matter what I do, I get the same [autoapi.not_readable] error. I cannot find documentation for it online.


Solution

  • This issue is likely caused by a recent pre-release of astroid, which seems to be causing compatibility issues with sphinx-autoapi. Read permissions errors for sphinx-autoapi, only on readthedocs #11975 I pinned the astroid version to the actual 3.3.8. and this worked fine for me