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

Add exception for SVG images #97

Merged
merged 9 commits into from
Feb 9, 2023
Merged

Conversation

choldgraf
Copy link
Contributor

I think this is a minimal patch to avoid breaking when a user has an SVG image. Ideally we would catch this and raise a warning in Sphinx, but I wanted to show the minimal patch to avoid the bug if you wanna make a patch release. I likely don't have time to do a proper implementation w/ a warning and such (am expecting a baby any day now)

@choldgraf
Copy link
Contributor Author

Just signal-boosting this. I'd recommend a patch release just after. As-is, anybody that was using an .svg file for their html_logo will have a broken Sphinx build when they upgrade to the latest sphinxext-opengraph.

1 similar comment
@choldgraf
Copy link
Contributor Author

Just signal-boosting this. I'd recommend a patch release just after. As-is, anybody that was using an .svg file for their html_logo will have a broken Sphinx build when they upgrade to the latest sphinxext-opengraph.

@Daltz333
Copy link
Member

Daltz333 commented Feb 8, 2023

Can we have a test for this so anything similar doesn't bit us in the future?

@choldgraf
Copy link
Contributor Author

OK the latest push adds a test that fails on main but passes with this change. I couldn't find a way to catch the warning messages in Sphinx but at least this will fail if we regress the check for SVG. I also added a check to make sure the path exists for good measure.

@Daltz333 Daltz333 merged commit 6deac99 into wpilibsuite:main Feb 9, 2023
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.

Social card previews break when SVG images present
2 participants