👌 IMPROVE: Use Sphinx HTML assets policy to decide whether include assets#132
Merged
👌 IMPROVE: Use Sphinx HTML assets policy to decide whether include assets#132
Conversation
…sets Sphinx v4.1.0 will include `Sphinx.registry.html_assets_policy` that defines the policy to whether include or not HTML assets in pages where the extension is not used. This PR makes usage of this policy to decide if sphinx-tabs assets should be included or not in the page that's being rendered. Reference: sphinx-doc/sphinx#9115
Codecov Report
@@ Coverage Diff @@
## master #132 +/- ##
==========================================
- Coverage 92.55% 92.23% -0.33%
==========================================
Files 2 2
Lines 215 219 +4
==========================================
+ Hits 199 202 +3
- Misses 16 17 +1
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
stsewd
added a commit
to readthedocs/sphinx-hoverxref
that referenced
this pull request
Nov 11, 2024
We are disconnecting the html-page-context event from sphinx-tabs, which was used to delete the static files from html files that didn't use sphinx-tabs. But in executablebooks/sphinx-tabs#198 this was changed to instead decide if the page should have the static files or not. Since we are removing that event, sphinx-tabs never gets to inject the static files, this breaks sphinx-tabs for projects using hoverxref. We no longer need to disconnect that signal, since we are overriding the html assets policy to `always`, which sphnx-tabs respects already executablebooks/sphinx-tabs#132 (more than 3 years ago).
stsewd
added a commit
to readthedocs/sphinx-hoverxref
that referenced
this pull request
Nov 11, 2024
We are disconnecting the html-page-context event from sphinx-tabs, which was used to delete the static files from html files that didn't use sphinx-tabs. But in executablebooks/sphinx-tabs#198 this was changed to instead decide if the page should have the static files or not. Since we are removing that event, sphinx-tabs never gets to inject the static files, this breaks sphinx-tabs for projects using hoverxref. We no longer need to disconnect that signal, since we are overriding the html assets policy to `always`, which sphnx-tabs respects already executablebooks/sphinx-tabs#132 (more than 3 years ago).
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
See #127