Raise informative error message when building man on older sphinx #158
Conversation
This file contains hidden or 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
This will make the case of building manpages with earlier sphinx fail with an informative error message ``` ValueError: Two different values of iframe_src attributes["iframe_src"]='lite/repl/index.html?kernel=xeus-python&toolbar=0&theme=JupyterLab%20Light&code=print%28%22Hello%20from%20a%20JupyterLite%20console%21%22%29',iframe_src='lite/repl/index.html', try upgrading sphinx to v 7.2.0 or more recent ``` Closes jupyterlite#117 As noted in the issue, we could pin sphinx to >7.2, but is it really necessary if it only affects man pages ?
agriyakhetarpal
approved these changes
Mar 29, 2024
Member
agriyakhetarpal
left a comment
agriyakhetarpal
left a comment
There was a problem hiding this comment.
I think raising an error should be okay here. I did a quick GitHub code search and while the man phony still exists in a lot of Makefiles, I don't think it's being widely used outside them in other sorts of scripts by projects (~672 results). The HTML builder is quite widely used instead with more than ~100k results, so it's reasonable to raise this error if popularity is used as a heuristic.
steppi
approved these changes
Mar 29, 2024
Collaborator
steppi
left a comment
steppi
left a comment
There was a problem hiding this comment.
Looks good to me. It seems reasonable not to break things for people who are stuck on sphinx<7.2 for some reason and who don't need to generate man pages.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
This will make the case of building manpages with earlier sphinx fail with an informative error message
Closes #117
As noted in the issue, we could pin sphinx to >7.2, but is it really necessary if it only affects man pages ?