[Docs] Fix Data examples TOC and rendering #36404
Merged
Conversation
This file contains 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
Signed-off-by: amogkam <amogkamsetty@yahoo.com>
matthewdeng
approved these changes
Jun 14, 2023
angelinalg
approved these changes
Jun 14, 2023
doc/source/_toc.yml
Outdated
| @@ -96,7 +96,7 @@ parts: | |||
| - file: data/getting-started | |||
| - file: data/key-concepts | |||
| - file: data/user-guide | |||
| - file: data/examples | |||
| - file: data/data_examples | |||
There was a problem hiding this comment.
Suggested change
| - file: data/data_examples | |
| - file: data/data_examples | |
| title: Examples |
There was a problem hiding this comment.
Are you open to keeping the name the same?
There was a problem hiding this comment.
The name isn't changed in this PR. It's still being pulled from the title of data_examples.rst
There was a problem hiding this comment.
I think you can set it with that title line, no?
There was a problem hiding this comment.
If not provided, it will default to the title in the rst file
maxpumperla
approved these changes
Jun 14, 2023
bveeramani
approved these changes
Jun 14, 2023
Comment on lines
+10
to
+20
| .. toctree:: | ||
| :hidden: | ||
|
|
||
| huggingface_vit_batch_prediction | ||
| pytorch_resnet_batch_prediction | ||
| batch_inference_object_detection | ||
| nyc_taxi_basic_processing | ||
| batch_training | ||
| ocr_example | ||
| random-access | ||
| custom-datasource |
There was a problem hiding this comment.
These will show up in the navbar.
There was a problem hiding this comment.
yep, as you mentioned offline, doesn't seem there's an easy way to avoid this
8 tasks
arvind-chandra
pushed a commit
to lmco/ray
that referenced
this pull request
Aug 31, 2023
b10f19d renamed the examples file for Ray Data. We have to make the corresponding change to the TOC, so that the page still shows up on the docs. Also removes the example files from exclude_patterns so they are built correctly. Includes the examples in a hidden toctree to prevent sphinx warnings. --------- Signed-off-by: amogkam <amogkamsetty@yahoo.com> Signed-off-by: e428265 <arvind.chandramouli@lmco.com>
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.
b10f19d renamed the examples file for Ray Data.
We have to make the corresponding change to the TOC, so that the page still shows up on the docs.
Also removes the example files from
exclude_patternsso they are built correctly.Includes the examples in a hidden toctree to prevent sphinx warnings.
Why are these changes needed?
Related issue number
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.