Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🚀 Pull Request
Description
This PR temporarily resolves the existing documentation build failure on RTD i.e., see here
There are a couple of factors in play here:
sphinx-panels
package is no longer maintained (sphinx-panels package no longer maintained #5121) and is pinning back thesphinx
package from >=v6.0.0 to v4.5.0 onconda-forge
pydata-sphinx-theme
is pinned to v0.8.1 (latest version available is >=v0.12.0), and this is causing the additionalpip install
step on RTD to pull thesphinx
package way down to v3.5.3 which is incompatible and, I suspect, causing the following traceback:We can circumvent this dependency carnage (no thanks to
pip
) by introducing the temporary maximum pinsphinx<5
within thesetup.cfg
, which prevent thepip
dependency resolver "stuffing up" ™️, and maintaining the compatible dependencies resolved and installed byconda
.However, as a follow-up, I strongly recommend that we address:
sphinx
pydata-sphinx-theme
back at v0.8.1The documentation built by this PR can be viewed here and the RTD raw build output is available here.
Consult Iris pull request check list