Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Why are these changes needed?
This PR fixes some issues with the sidebar that arose from caching the HTML for the sidebar. In short, I had issues getting the JS to store the checkbox state to work. I solved this in python, by reusing the cached toctree HTML but setting the "checked" state on the appropriate dropdown inputs on each page using
beautifulsoup
. The operation comes with an overhead, but it's still quite small compared to reconstructing a new toctree every page write.Related issue number
Partially addressed ray-project#37944.
Targets ray-project#41115.
Checks
git commit -s
) in this PR.scripts/format.sh
to lint the changes in this PR.method in Tune, I've added it in
doc/source/tune/api/
under thecorresponding
.rst
file.