Add Sphinx.add_html_assets_in_all_pages
#9174
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
This new method in the `Sphinx` object allows extensions to communicate to Sphinx that it's preferred to include HTML assets in all the pages. However, it's extensions developers' responsability to follow this config and decide whether or not include the assets required. Extensions developers' can check `Sphinx.html_assets_in_all_pages` together with any other logic they may have to decide if the assets will be included in the rendered page or not. Closes sphinx-doc#9115
tk0miya
reviewed
May 12, 2021
humitos
commented
Jun 14, 2021
| @@ -79,7 +79,7 @@ def install_mathjax(app: Sphinx, pagename: str, templatename: str, context: Dict | |||
| 'mathjax extension to work') | |||
|
|
|||
| domain = cast(MathDomain, app.env.get_domain('math')) | |||
| if domain.has_equations(pagename): | |||
| if app.registry.html_assets_policy == 'always' or domain.has_equations(pagename): | |||
There was a problem hiding this comment.
@tk0miya I don't like too much how this line is checking for the always policy. Do you have a better suggestion for this?
|
Any bump on this? This PR is probably the only blocker on my team for migration to Sphinx 4.0 |
|
Merged. Thank you for your work! |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Subject: Add an API to enable including assets in all HTML pages.
Feature or Bugfix
Purpose
This new method in the
Sphinxobject allows extensions to communicate to Sphinx that it's preferred to include HTML assets in all the pages. However, it's extensions developers' responsibility to follow this config and decide whether or not to include the assets required.Extensions developers' can check
Sphinx.html_assets_in_all_pagestogether with any other logic they may have to decide if the assets will be included in the rendered page or not.Relates