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

Broken Readthedocs Preview #129

Closed
mabruzzo opened this issue Nov 13, 2021 · 4 comments
Closed

Broken Readthedocs Preview #129

mabruzzo opened this issue Nov 13, 2021 · 4 comments

Comments

@mabruzzo
Copy link
Contributor

The automatic ReadtheDocs preview-builds seem to be broken. This is evident in PR #128 (which only changes 2 lines and doesn't touch any of the documentation).

(I think this is also causing the preview-builds to fail for PR #113.)

Looking at the error-messages I think some python dependency got updated and is now incompatible with the rest of our build environment.

I'm happy to try to resolve this myself. I'm just not sure where these builds are configured (or if I have privileges to access that stuff). Can somebody point me in the right direction? (maybe @brittonsmith)

@jobordner
Copy link
Contributor

This issue looks relevant: sphinx-doc/sphinx#9727

@mabruzzo
Copy link
Contributor Author

I think you're absolutely right. The solution seems to be to pin docutils to <0.18 (or to update the version of sphinx that we're using).

I suspect that preview builds were enabled using these instructions. So to fix it, I think that we need to modify the build settings through the enzo-e project page on ReadTheDocs site.

I think that currently, only you and Britton have admin access to that site (so one of you needs to fix it). Alternatively, I could take a shot at fixing this, but I would need to be linked to the project.

@mabruzzo
Copy link
Contributor Author

This seems to have been resolved. I'm not sure whether

  • James or Britton fixed this issue, or
  • if the issue resolved itself (e.g. maybe sphinx updated its dependencies).

@brittonsmith
Copy link
Contributor

I encountered this recently somewhere else and banged against it for a while, to no avail. Then it just went away. It seems to be something that RTD corrected themselves.

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

3 participants