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

[CherryPick][Core][Doc] #32236 #32520 #32551 #32570 #32536

Merged
merged 5 commits into from
Feb 16, 2023
Merged

[CherryPick][Core][Doc] #32236 #32520 #32551 #32570 #32536

merged 5 commits into from
Feb 16, 2023

Conversation

jjyao
Copy link
Collaborator

@jjyao jjyao commented Feb 14, 2023 •
edited
Loading

Why are these changes needed?

#32236 #32520 #32551 #32570

Related issue number

Checks

  • I've signed off every commit(by using the -s flag, i.e., git commit -s) in this PR.
  • I've run scripts/format.sh to lint the changes in this PR.
  • I've included any doc changes needed for https://docs.ray.io/en/master/.
  • I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/
  • Testing Strategy
    • Unit tests
    • Release tests
    • This PR is not tested :(

@jjyao jjyao closed this Feb 14, 2023
@jjyao jjyao reopened this Feb 14, 2023
@jjyao jjyao changed the base branch from master to releases/2.3.0 February 14, 2023 18:02
cadedaniel
cadedaniel approved these changes Feb 14, 2023
View reviewed changes
Copy link
Member

@cadedaniel cadedaniel left a comment

Choose a reason for hiding this comment

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

LGTM, all changes are doc changes.

Let's wait until doc tests pass before merging

zhe-thoughts
zhe-thoughts approved these changes Feb 14, 2023
View reviewed changes
Copy link
Collaborator

@zhe-thoughts zhe-thoughts left a comment

Choose a reason for hiding this comment

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

Approved for picking into 2.3.0

jjyao added 2 commits February 14, 2023 13:13
@jjyao
[Doc] Restructure core API docs (#32236)
28c745e 
Similar to #31204, refactor the core api reference for better layout and view.

Signed-off-by: Jiajun Yao <jeromeyjj@gmail.com>
@jjyao
Fix autosummary to show docstring of class members (#32520)
779caa1 
By default, autosummary only shows one line for each class member instead of the entire docstring. Ideally the fix should be autosummarying class members as well but that generates too many doc pages and causes doc build timeout. For now, default to show docstring of class members in the class pages and an explicit opt-in to autosummary class members.

Signed-off-by: Jiajun Yao <jeromeyjj@gmail.com>
@cadedaniel
Copy link
Member

@jjyao is @justinvyu working on the doctest failures? is there a summary of the issue?

@justinvyu
Copy link
Contributor

justinvyu commented Feb 14, 2023 •
edited
Loading

Summary:

Classes included in autosummary now show all member + docstrings by default, and if a member of the class gets included in the autosummary, then there's a duplicate reference that will be indexed twice - causing the errors. The fix is using Jiajun's class_with_autosummary.rst template for these to prevent duplicates. Will have a fix up in 10 min.

@justinvyu
Copy link
Contributor

@cadedaniel PR with fix is here #32551 (waiting to merge into master)

@jjyao jjyao changed the title [CherryPick][Core][Doc] #32236 #32520 [CherryPick][Core][Doc] #32236 #32520 #32551 #32570 Feb 16, 2023
@jjyao jjyao merged commit 095de26 into releases/2.3.0 Feb 16, 2023
@jjyao jjyao deleted the jjyao/cherry branch February 16, 2023 01:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@zhe-thoughts zhe-thoughts zhe-thoughts approved these changes

@cadedaniel cadedaniel cadedaniel approved these changes

@krfricke krfricke Awaiting requested review from krfricke krfricke is a code owner

@rkooo567 rkooo567 Awaiting requested review from rkooo567

@simon-mo simon-mo Awaiting requested review from simon-mo simon-mo is a code owner

@richardliaw richardliaw Awaiting requested review from richardliaw richardliaw is a code owner

@gjoliver gjoliver Awaiting requested review from gjoliver gjoliver is a code owner

@xwjiang2010 xwjiang2010 Awaiting requested review from xwjiang2010 xwjiang2010 is a code owner

@amogkam amogkam Awaiting requested review from amogkam amogkam is a code owner

@matthewdeng matthewdeng Awaiting requested review from matthewdeng matthewdeng is a code owner

@Yard1 Yard1 Awaiting requested review from Yard1 Yard1 is a code owner

@maxpumperla maxpumperla Awaiting requested review from maxpumperla maxpumperla is a code owner

@edoakes edoakes Awaiting requested review from edoakes edoakes is a code owner

@jiaodong jiaodong Awaiting requested review from jiaodong jiaodong is a code owner

@shrekris-anyscale shrekris-anyscale Awaiting requested review from shrekris-anyscale shrekris-anyscale is a code owner

@sihanwang41 sihanwang41 Awaiting requested review from sihanwang41 sihanwang41 is a code owner

@architkulkarni architkulkarni Awaiting requested review from architkulkarni architkulkarni is a code owner

@wuisawesome wuisawesome Awaiting requested review from wuisawesome wuisawesome is a code owner

@DmitriGekhtman DmitriGekhtman Awaiting requested review from DmitriGekhtman DmitriGekhtman is a code owner

@pcmoritz pcmoritz Awaiting requested review from pcmoritz pcmoritz is a code owner

@sven1977 sven1977 Awaiting requested review from sven1977 sven1977 is a code owner

@avnishn avnishn Awaiting requested review from avnishn avnishn is a code owner

@ArturNiederfahrenhorst ArturNiederfahrenhorst Awaiting requested review from ArturNiederfahrenhorst ArturNiederfahrenhorst is a code owner

@smorad smorad Awaiting requested review from smorad

@kouroshHakha kouroshHakha Awaiting requested review from kouroshHakha kouroshHakha is a code owner

@ericl ericl Awaiting requested review from ericl ericl is a code owner

@fishbone fishbone Awaiting requested review from fishbone

@stephanie-wang stephanie-wang Awaiting requested review from stephanie-wang

@suquark suquark Awaiting requested review from suquark

@scv119 scv119 Awaiting requested review from scv119 scv119 is a code owner

@clarkzinzow clarkzinzow Awaiting requested review from clarkzinzow clarkzinzow is a code owner

@jianoaix jianoaix Awaiting requested review from jianoaix jianoaix is a code owner

@c21 c21 Awaiting requested review from c21 c21 is a code owner

@jovany-wang jovany-wang Awaiting requested review from jovany-wang

@kfstorm kfstorm Awaiting requested review from kfstorm

@raulchen raulchen Awaiting requested review from raulchen

@WangTaoTheTonic WangTaoTheTonic Awaiting requested review from WangTaoTheTonic

@thomasdesr thomasdesr Awaiting requested review from thomasdesr

Assignees

@cadedaniel cadedaniel

@zhe-thoughts zhe-thoughts

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@jjyao @cadedaniel @justinvyu @zhe-thoughts