Skip to content

docs: mention CRC32 checksum for add_js_file and add_css_file (7.1) #14012

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
+11 −2
Open

docs: mention CRC32 checksum for add_js_file and add_css_file (7.1) #14012

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b17cda8
docs: mention CRC32 checksum changes for add_js_file and add_css_file…
Devika9705 Nov 2, 2025
5b08a28
docs: fix references and update API docs for add_js_file/add_css_file…
Devika9705 Nov 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
docs: mention CRC32 checksum changes for add_js_file and add_css_file… 
… (7.1)
  • Loading branch information
@Devika9705
Devika9705 committed Nov 2, 2025
commit b17cda8cac02283b69b47994b5e17c69d77126f4
4 changes: 3 additions & 1 deletion doc/extdev/appapi.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,10 @@ package.
.. automethod:: Sphinx.add_post_transform

.. automethod:: Sphinx.add_js_file

.. versionchanged:: 7.1 Added CRC32 checksums to asset URIs for improved caching and integrity. When JavaScript files are added, a CRC32 checksum is now appended to the URI (e.g. ``_static/example.js?abcd1234``). This helps browsers detect when files have changed and refresh cached versions automatically. For more details, see the 7.1.0 changelog entry: https://www.sphinx-doc.org/en/master/changes.html#release-7-1-0-released-jul-24-2023 Site authors can also use the configuration options :confval:`html_js_files` and :confval:`html_static_path` to manage static JS files. Files in ``html_static_path`` override those added by extensions.
.. automethod:: Sphinx.add_css_file
.. versionchanged:: 7.1
Added CRC32 checksums to asset URIs for CSS files as well, following the same caching and integrity improvements as :meth:`.Sphinx.add_js_file`.h:`.Sphinx.add_js_file`.

.. automethod:: Sphinx.add_latex_package

Expand Down
Loading