Fix docs failure after new sphinx release #127
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Fixed by specifying sphinx < 8 for python < 3.11. We should also include python 3.11 and 3.12 in the CI, and progressively free dependencies, to prepare for an upgrade in the near future (issue #120). |
|
It seems now that there is some problem with Python 3.11. |
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
PR #125 tests passed, however after merging to the main branch, docs are failing. This PR is to investigate and fix this issue.
Results:
The issue is caused by the new sphinx 8.0 and myst_parser 4.0 that were released between the last run of PR #125 and the merge (2024-07-29 and 2024-08-05). It happens only with python 3.10.9, but works fine with python 3.11.
Python 3.10.9, sphinx 7.4, myst_parser 3.0: works
Python 3.10.9, sphinx 8.0.2, myst_parser 4.0: issue
Python 3.11, sphinx 7.4, myst_parser 3.0: works
Python 3.11, sphinx 8.0.2, myst_parser 4.0: works
It seems that the notebooks have not been run at the build-finished event.