Skip to content
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

Jump to bottom

[doc] Add sphinx-autobuild and documentation for make local #47275

Merged
merged 13 commits into from
Aug 23, 2024
Merged

[doc] Add sphinx-autobuild and documentation for make local #47275

merged 13 commits into from
Aug 23, 2024

Conversation

khluu
Copy link
Contributor

@khluu khluu commented Aug 22, 2024 •
edited
Loading

  • Split doc building into 2 options: incremental build with caching & full build from scratch.
  • Add description & explanation of the process for incremental build option.
  • Use sphinx-autobuild instead of sphinx-build for auto reload upon doc changes.

@khluu khluu requested a review from a team as a code owner August 22, 2024 09:06
angelinalg
angelinalg approved these changes Aug 22, 2024
View reviewed changes
Copy link
Contributor

@angelinalg angelinalg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for doing this. Can you also add the troubleshooting tips that have already come up, like, use a clean env, don't build Ray, etc.

doc/source/ray-contribute/docs.md Outdated Show resolved Hide resolved
doc/source/ray-contribute/docs.md Outdated Show resolved Hide resolved
doc/source/ray-contribute/docs.md Outdated Show resolved Hide resolved
doc/source/ray-contribute/docs.md Outdated Show resolved Hide resolved
doc/source/ray-contribute/docs.md Outdated Show resolved Hide resolved
doc/source/ray-contribute/docs.md Outdated Show resolved Hide resolved
doc/source/ray-contribute/docs.md Outdated Show resolved Hide resolved
doc/source/ray-contribute/docs.md Show resolved Hide resolved
doc/source/ray-contribute/docs.md Outdated Show resolved Hide resolved
doc/source/ray-contribute/docs.md Outdated Show resolved Hide resolved
@can-anyscale can-anyscale enabled auto-merge (squash) August 22, 2024 20:37
@github-actions github-actions bot added the go add ONLY when ready to merge, run all tests label Aug 22, 2024
@github-actions github-actions bot disabled auto-merge August 22, 2024 20:59
khluu and others added 12 commits August 22, 2024 14:25
@khluu
p
5f9d7cb 
Signed-off-by: khluu <[email protected]>
@khluu @angelinalg
Add Angelina's suggestion
ebea9a4 
Co-authored-by: angelinalg <[email protected]>
Signed-off-by: Kevin H. Luu <[email protected]>
Signed-off-by: khluu <[email protected]>
@khluu @angelinalg
Add Angelina's suggestion
7a43371 
Co-authored-by: angelinalg <[email protected]>
Signed-off-by: Kevin H. Luu <[email protected]>
Signed-off-by: khluu <[email protected]>
@khluu @angelinalg
Add Angelina's suggestion
2ff0f03 
Co-authored-by: angelinalg <[email protected]>
Signed-off-by: Kevin H. Luu <[email protected]>
Signed-off-by: khluu <[email protected]>
@khluu @angelinalg
Add Angelina's suggestion
96f0b09 
Co-authored-by: angelinalg <[email protected]>
Signed-off-by: Kevin H. Luu <[email protected]>
Signed-off-by: khluu <[email protected]>
@khluu @angelinalg
Add Angelina's suggestion
7ff845c 
Co-authored-by: angelinalg <[email protected]>
Signed-off-by: Kevin H. Luu <[email protected]>
Signed-off-by: khluu <[email protected]>
@khluu @angelinalg
Add Angelina's suggestion
96e5593 
Co-authored-by: angelinalg <[email protected]>
Signed-off-by: Kevin H. Luu <[email protected]>
Signed-off-by: khluu <[email protected]>
@khluu @angelinalg
Add Angelina's suggestion
4b62746 
Co-authored-by: angelinalg <[email protected]>
Signed-off-by: Kevin H. Luu <[email protected]>
Signed-off-by: khluu <[email protected]>
@khluu @angelinalg
Add Angelina's suggestion
469036f 
Co-authored-by: angelinalg <[email protected]>
Signed-off-by: Kevin H. Luu <[email protected]>
Signed-off-by: khluu <[email protected]>
@khluu @angelinalg
Add Angelina's suggestion
ccde0a6 
Co-authored-by: angelinalg <[email protected]>
Signed-off-by: Kevin H. Luu <[email protected]>
Signed-off-by: khluu <[email protected]>
@khluu
p
1d0c6a7 
Signed-off-by: khluu <[email protected]>
@khluu
p
83ec481 
Signed-off-by: khluu <[email protected]>
@khluu khluu force-pushed the khluu/update_new_doc_build branch from 0be5108 to 83ec481 Compare August 22, 2024 21:25
@khluu
format
765f55d 
Signed-off-by: khluu <[email protected]>
@khluu khluu changed the title [doc] Documentation for make local [doc] Add sphinx-autobuild and documentation for make local Aug 22, 2024
@can-anyscale can-anyscale merged commit 6743d3d into master Aug 23, 2024
5 checks passed
@can-anyscale can-anyscale deleted the khluu/update_new_doc_build branch August 23, 2024 00:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@can-anyscale can-anyscale can-anyscale approved these changes

@angelinalg angelinalg angelinalg approved these changes

Assignees
No one assigned
Labels
go add ONLY when ready to merge, run all tests
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@khluu @angelinalg @can-anyscale