Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use app.set_html_assets_policy as 'always' #136

Merged
merged 3 commits into from Jul 12, 2021

Conversation

humitos
Copy link
Member

@humitos humitos commented Jul 5, 2021

Tell Sphinx to always include assets in all HTML pages

Closes #119

@humitos humitos requested a review from a team July 5, 2021 09:03
@humitos humitos force-pushed the humitos/set-html-assets-policy branch from b525eb5 to 7c46550 Compare July 5, 2021 09:05
Tell Sphinx to always include assets in all HTML pages

Closes #119
@Daltz333
Copy link
Contributor

Daltz333 commented Jul 6, 2021

I'm not sure of a clean way to convey to users that Sphinx 3.5->4.0.2 is broken? Can we throw an info statement?

@humitos
Copy link
Member Author

humitos commented Jul 6, 2021

I'm not sure of a clean way to convey to users that Sphinx 3.5->4.0.2 is broken?

It's not completely broken. There is only one case that doesn't work: embedding math formulas from pages that don't include math formulas. So, I don't think we should add code to communicate this particular case.

Can we throw an info statement?

I've added a warning note in https://sphinx-hoverxref.readthedocs.io/en/latest/usage.html#tooltip-with-content-that-needs-extra-rendering-steps that we need to update to mention that this is fixed in Sphinx 4.1.0

BTW, why you are mentioning 4.0.2 as the version that fixes this? I saw that my PR was tagged as 4.1.0: sphinx-doc/sphinx#9174

Copy link
Member

@ericholscher ericholscher left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

hoverxref/extension.py Outdated Show resolved Hide resolved
@humitos humitos merged commit a7fbed3 into master Jul 12, 2021
@humitos humitos deleted the humitos/set-html-assets-policy branch July 12, 2021 13:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

sphinx>=3.5 does not render tabs/math formulas
3 participants