disnake icon indicating copy to clipboard operation
disnake copied to clipboard

Docs: cache bust and faster hoverxref

Open bast0006 opened this issue 3 years ago • 2 comments

Summary

This PR busts the CSS/JS caches because despite RTD's documentation stating they "bust the cache" every time a new version is submitted, there have been reports of users with the unfortunate experience of having old JS running with newer html.

This PR also replaces the live version of sphinx-hoverxref with a forked version that has been altered to utilize lazy-loaded hoverxref hooks instead of on-page-load, which should dramatically speed up page load times.

Checklist

  • [x] If code changes were made, then they have been tested
    • [ ] I have updated the documentation to reflect the changes
    • [ ] I have formatted the code properly by running task lint
    • [ ] I have type-checked the code by running task pyright
  • [ ] This PR fixes an issue
  • [ ] This PR adds something new (e.g. new method or parameters)
  • [ ] This PR is a breaking change (e.g. methods or parameters removed/renamed)
  • [x] This PR is not a code change (e.g. documentation, README, ...)

bast0006 avatar Mar 06 '22 03:03 bast0006

@bast0006 any status on when the pr to sphinx-hoverxref will be made?

onerandomusername avatar Jun 06 '22 00:06 onerandomusername

update: the pr has been made: https://github.com/readthedocs/sphinx-hoverxref/pull/227

onerandomusername avatar Sep 17 '22 03:09 onerandomusername

Due to the cache bust and other general speedups here, I'd like to merge this after #722 unless there is an extended period after this pr is ready and #722 is still not ready.

onerandomusername avatar Oct 04 '22 03:10 onerandomusername

Due to the cache bust

that only affects select files and shouldn't be relevant to #722, I think. It might be worth consideration to actually do that for all js files, may be difficult to do with sphinx though.

shiftinv avatar Oct 04 '22 10:10 shiftinv

This PR as it is currently breaks the dark theme toggle.

onerandomusername avatar Oct 16 '22 05:10 onerandomusername

It's just the cache bust doing it (sigh). Pushing a fix shortly.

bast0006 avatar Oct 16 '22 20:10 bast0006