Skip to content
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

Read permissions errors for sphinx-autoapi, only on readthedocs #11975

Closed
c-randall opened this issue Feb 4, 2025 · 2 comments
Closed

Read permissions errors for sphinx-autoapi, only on readthedocs #11975

c-randall opened this issue Feb 4, 2025 · 2 comments

Comments

@c-randall
Copy link

Details

Expected Result

There might be a read permissions error somewhere on the runners. I previously have not had any issues building my documentation on readtehdocs, but starting today I've been getting read errors from the sphinx-autoapi extension.

I made a few changes to my package but did not change anything about the documentation build/configuration, so I expected the documentation to build normally, but it did not. I also built the documentation successfully locally, so I did not expect to have errors on readthedocs.

Actual Result

I am getting errors saying Unable to read file and [autoapi.not_readable] for every file in my package. I do not get these errors locally. This results in an overall failed build on readthedocs.

What I tried:

  • using two different older versions of sphinx-autoapi, which did not fix the issue.
  • using chmod -R a+r ./* in build.jobs.pre_build to make all files/folders have read permissions, but that didn't work.
  • rebuilding a previously successful branch without making any modifications to the files, this now gives the same error I'm seeing on all my other branches, even though it was previously successful

I cannot find any good documentation online for someone who has dealt with this same error. Hoping this is a bug someone can help me fix so I can get my documentation building again.

@c-randall
Copy link
Author

Resolved by pinning astroid>=3 to remove re-release versions. PR #514 should hopefully resolve this.

For now, I got my package working by adding astroid>=3 to my optional [docs] dependencies, in case this helps anyone else.

@gabalafou
Copy link

This fix (astroid>=3) worked for us, too, thank you! pydata/pydata-sphinx-theme#2125

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