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

sphinx >= 7.2 appears to break piccolo theme #61

Closed
alexlancaster opened this issue Aug 22, 2023 · 5 comments
Closed

sphinx >= 7.2 appears to break piccolo theme #61

alexlancaster opened this issue Aug 22, 2023 · 5 comments

Comments

@alexlancaster
Copy link

alexlancaster commented Aug 22, 2023

I upgraded to sphinx 7.2.2 and I now get this error (also happens with 7.2.0, 7.2.1 - seems to have been introduced in 7.2.x series):

writing output... [ 10%] docs/AUTHORS
Theme error:
An error happened in rendering the page docs/AUTHORS.
Reason: ThemeError("Local asset file paths must not contain query strings: '_static/basic_mod.css?v=0.7.0-1'")

If I revert to 7.1.2 and earlier, I don't encounter this error.

@alexlancaster
Copy link
Author

I wonder if this problem is related to this: sphinx-doc/sphinx#11608 ?

@dantownsend
Copy link
Member

dantownsend commented Aug 22, 2023

@alexlancaster Thanks for reporting this.

Seems like there was a lot of changes in Sphinx 7.2

The reason we add a GET param to the CSS path is for cache busting - browsers will ignore their cached CSS if they see a different GET param.

If we remove the GET param, it's not the end of the world.

@dantownsend
Copy link
Member

I just checked, and removing the GET param fixes it - will do a release tomorrow.

@dantownsend
Copy link
Member

This should be fixed now in piccolo_theme==0.17.0.

I've added some integration tests, so we're now testing against a range of Sphinx versions.

@alexlancaster
Copy link
Author

I just pip updated to latest piccolo-theme and sphinx 7.2.2 and my docs build fine now. Thank you!

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

No branches or pull requests

2 participants