Skip to content

Conversation

@Devika9705
Copy link

This pull request updates the documentation in doc/extdev/appapi.rst to reflect recent changes introduced in Sphinx 7.1, where app.add_js_file() and app.add_css_file() now automatically include a CRC32 checksum for static files.

Summary of Changes

  • Updated the documentation to mention the new CRC32 checksum behavior.
  • Clarified how this affects browser caching and file updates for JS and CSS assets.

Why This Matters

Adding the CRC32 checksum ensures that browsers automatically reload updated assets without relying on manual cache clearing, improving developer experience and reliability in extension development.

References


Purpose

This PR improves developer-facing documentation by clarifying recent updates to the JavaScript and CSS inclusion APIs (add_js_file and add_css_file).
No code changes are made — this is a documentation-only update.

References

@AA-Turner
Copy link
Member

Hi, if using LLMs to create PRs please (a) disclose this fact and (b) ensure that the PR doesn't contain unneeded changes.

Also, here we add the checksum to all asset files, not just via these API calls.

A

@Devika9705
Copy link
Author

Hi, if using LLMs to create PRs please (a) disclose this fact and (b) ensure that the PR doesn't contain unneeded changes.

Also, here we add the checksum to all asset files, not just via these API calls.

A

Thank you for your concern. As a beginner learning through LLMs, I will update the PR as you mentioned.

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.

2 participants