[Doc] Add docs index page#4
Merged
peytondmurray merged 1 commit intodocs-build-system-upgradefrom Nov 16, 2023
Merged
Conversation
Signed-off-by: pdmurray <peynmurray@gmail.com>
maxpumperla
approved these changes
Nov 15, 2023
maxpumperla
left a comment
There was a problem hiding this comment.
great, straightforward enough. Splitting up the CSS is a very good idea.
peytondmurray
pushed a commit
that referenced
this pull request
Jan 10, 2024
…o allow updating from Episodes. (ray-project#41235)
peytondmurray
pushed a commit
that referenced
this pull request
Jun 20, 2024
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 modifies the index page. It's one of the most complicated pages, and was therefore affected more than most by the upgrade. I've broken the page up into logical pieces to make it easier to maintain.
Note: For some reason git thinks I've renamed files when really the contents are totally different 🤷
indexpage, but the entire page was wrapped in a raw html block. Instead of this I've created anindex.rstcontaining the top-level toctree for the docs. A separatesplash.htmlpage containing the main content is included via a raw html directive.splash.cssand inserted into the layout with thehtml-page-contextevent during the sphinx build for this page only. The same mechanism is used to insertsplash.jsfor handling the "Scaling With Ray" widget user interaction and code highlighting:Related issue number
Partially addresses ray-project#37944.
Depends on #2.
PR 3/x targeting ray-project#41115.
Checks
git commit -s) in this PR.scripts/format.shto lint the changes in this PR.method in Tune, I've added it in
doc/source/tune/api/under thecorresponding
.rstfile.