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

readthedocs build started failing in PRs and complains about wrong sphinx version #351

Closed
m-albert opened this issue Feb 21, 2024 · 4 comments

Comments

@m-albert
Copy link
Collaborator

readthedocs started to throw errors Sphinx version error in PRs such as #213 or #344. However, there were no changes to the readthedocs configuration and dependencies are all pinned.

It seems that sphinx 4.5. is being used for the build although version 5.3. is pinned here

What's interesting is that cat continuous_integration/environment-doc.yml on the readthedocs shows something different than continuous_integration/environment-doc.yml in the repository. Namely, there's a conda dependency sphinx added at the end, as if readthedocs added lines in the background.

I posted a question on stackoverflow regarding this.

@jakirkham
Copy link
Member

Looked at this for a bit, but couldn't figure out what was going on either

If I had to guess, a different Python environment is being used, which isn't the one we created

Would suggest raising an issue upstream. They should be able to advise on any next steps (like config updates) that we need to take

@m-albert
Copy link
Collaborator Author

m-albert commented Feb 23, 2024

Thanks John 🙏

I created an issue upstream as you suggested.

Yeah it seems to use a different environment. I wonder whether it could be related to the fact that there's an additional conda sphinx dependency shown in the RTD print of the used env file.

@jakirkham
Copy link
Member

Thank Marvin! 🙏

Yeah let's see what they say

Sounds plausible

@GenevieveBuckley
Copy link
Collaborator

Closing this issue now #354 is merged.

There is still some follow up work planned (removing the sphinx dependencies pinned in #354 when sphinx v5 is consistently being installed in the test environment. If needed, we can open a new issue to track this follow up.

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