-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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
sphinx.errors.VersionRequirementError: The sphinxcontrib.applehelp extension used by this project needs at least Sphinx v5.0 #11140
Comments
Would add this worked in December: https://readthedocs.org/projects/dask-image/builds/22749569/ Then started failing in January: https://readthedocs.org/projects/dask-image/builds/23277934/ Somewhere in there something changed. Hopefully this helps us narrow it down |
We encountered this bug as well. This error is coming from Sphinx, not Read the Docs though. The cause of the problem is some unpinned dependencies of Sphinx were upgraded in a backwards incompatible way. The fix is to upgrade to version 5, unfortunately there is no way to patch this bug otherwise. Here's the bug report and discussion at Sphinx: I'll close this discussion here, but hopefully that helps solve your problem. |
Thanks Anthony! 🙏 We do request Sphinx 5.3.0 on this line and it does appear to get installed by Conda However there is still Sphinx 4.5.0 version that is getting used, but we didn't install that one Do we know where that is coming from? How can we make sure RTD uses the Sphinx we installed with Conda? |
Hah, that's ... unique. The build commands do look to be running from the conda installed Sphinx, I'm a bit at a loss why that is 4.5.0 though. I'm not the strongest with Conda tooling though. cc @humitos maybe you have input here? |
Just a guess, but an unbound Conda reports 5.3.0 is installed though, so not sure if that is important or not. |
Yeah think this is added (possibly by RTD) in the build somewhere. The environment file only has the Do see Sphinx 5.3.0 is installed once So think that is ok Do we know what |
I just recreated the conda environment locally and found that it installed sphinx=4.5. |
Okay we're not the only dask project that encountered this error 😅 and people have found a workaround: dask/dask-sphinx-theme#68 (comment). |
This was going to be my guess. The same dependency resolution issues happen with Anyways, glad you have a fix for now. I've also been recommending folks keep up to date on Sphinx releases, as Sphinx is not as backwards compatible these days. I'd aim for Sphinx 7 when you upgrade. |
Thanks @agjohnson !
I think it's actually pip that installed sphinx 4.5. Is maybe the --quiet argument in the mamba call preventing this from being printet?
Thanks for sharing this, that's good to know! |
That was also my guess: conda and pip doing/reporting different things.
As long as I know, the
However, I think you could install the theme from conda-forge as well to avoid this issue using https://github.com/conda-forge/dask-sphinx-theme-feedstock |
If I create the environment with mamba locally without using
Maybe it'd be useful to include this output during the RTD build (e.g. by taking out
This is a great idea, it probably makes sense to stay within conda when possible. Thanks @humitos for your help! |
I opened #11151 to track this. |
Details
Expected Result
readthedocs continues building successfully after no changes in
dask-image
's RTD configuration.Actual Result
Upstream report of dask/dask-image#351.
Quick summary: RTD fails saying the build requires
sphinx>=5
. Although the correct sphinx version is pinned in the environment yml file, the build seems to usesphinx=4.5
. Interestingly, the print of the environment file shows differences to the dask-image repo env file.Thanks for any hints on this 🙏
The text was updated successfully, but these errors were encountered: