sphinx_rtd_theme/layout: Set url_root properly on index, don't use '#' #1025
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
- You can see a practical demonstration of the problem, fully seeing the effect if it is not fixed, here (though that example uses the alabaster theme, the effect is the same here): executablebooks/sphinx-copybutton#110 - This is a copy of a fix from Sphinx. The sphinx pull request is sphinx-doc/sphinx#8524 Detailed description: - url_root is set to `#` on the index page, which layout.html tries to change back to `''` (the empty string). - But, this updated url_root wasn't used in the actual location, as an argument to `documentation_options.js`. - Thus, clever enough templates, which tried to use `$DOCUMENTATION_OPTIONS.URL_ROOT` inside javascript would fail. This was manifested as broken links, which led to this issue: executablebooks/sphinx-copybutton#110 - I have eventually traced that back to sphinx itself, and found that layout.html tried to fix the problem, but the fixed value wasn't used. - This fix works in my basic test, but I will continue with more tests. - Review: - someone more clever should examine this and make sure it makes sense - This does not have tests. Should it?
|
Thanks, I'm not that familiar with all this, but makes sense. I'll merge after is approved upstream sphinx-doc/sphinx#8524 |
|
Merged upstream now. |
stsewd
approved these changes
Dec 15, 2020
|
thanks! |
This was referenced Mar 14, 2021
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
the effect if it is not fixed, here (though that example uses the
alabaster theme, the effect is the same here):
copy button <img> doesn't work with dirhtml builder, only on root page executablebooks/sphinx-copybutton#110
sphinx/themes/basic/layout: Set url_root properly on index, don't use '#' sphinx-doc/sphinx#8524
Detailed description:
#on the index page, which layout.html tries tochange back to
''(the empty string).argument to
documentation_options.js.$DOCUMENTATION_OPTIONS.URL_ROOTinside javascript would fail.This was manifested as broken links, which led to this issue:
copy button <img> doesn't work with dirhtml builder, only on root page executablebooks/sphinx-copybutton#110
layout.html tried to fix the problem, but the fixed value wasn't
used.
sense