Skip to content

[Data][Docs] Sort references in Loading data and Saving data references (#60084) #60091

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
Open
mgchoi239 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[Data][Docs] Sort references in Loading data and Saving data references (#60084) #60091

mgchoi239 wants to merge 1 commit into from
+253 −193

Conversation

@mgchoi239
Copy link
Contributor

@mgchoi239 mgchoi239 commented Jan 13, 2026 •
edited
Loading

Categorize APIs into Public APIs and Developer APIs, and sort them alphabetically by service name.

Changes:

  • Reorganized loading_data.rst and saving_data.rst with Public APIs first, then Developer APIs
  • Sorted all APIs alphabetically by service name within each section
  • Sections that originally had APIs for both Public and Developer APIs were divided to respective sections
  • Removed datasource.FastFileMetadataProvider API that has been removed (reference)

Fixes #60084

Signed-off-by: mgchoi239 [email protected]

@mgchoi239 mgchoi239 requested a review from a team as a code owner January 13, 2026 05:52
@gemini-code-assist
Copy link
Contributor

gemini-code-assist bot commented Jan 13, 2026

Warning

You have reached your daily quota limit. Please wait up to 24 hours and I will start processing your requests again!

@mgchoi239
Copy link
Contributor Author

mgchoi239 commented Jan 13, 2026

Note: I categorized this based on API annotations (@publicapi vs @DeveloperAPI) so some libraries (e.g., Pandas, NumPy, Arrow) appear in both sections. Happy to merge this into a single section if that’s preferred.

@ray-gardener ray-gardener bot added docs An issue or change related to documentation data Ray Data-related issues community-contribution Contributed by the community labels Jan 13, 2026
@mgchoi239 mgchoi239 force-pushed the sort-data-api-docs branch 4 times, most recently from 3e712fc to c8d35c5 Compare January 14, 2026 04:57
@mgchoi239
Copy link
Contributor Author

mgchoi239 commented Jan 14, 2026 •
edited
Loading

  • Build failed because of missing library import, took some time to root cause because Sphinx returned an 'unknown error'
  • removed datasource.FastFileMetadataProvider because API has been removed (reference)

bveeramani
bveeramani reviewed Jan 16, 2026
View reviewed changes
Copy link
Member

@bveeramani bveeramani left a comment

Choose a reason for hiding this comment

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

ty for the contribution.

Overall LGTM

doc/source/data/api/loading_data.rst
read_webdataset

Kafka
Developer APIs
Copy link
Member

@bveeramani bveeramani Jan 14, 2026

Choose a reason for hiding this comment

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

Could we change all of the developer API headings (e.g., "Datasink") to be subheadings of "Developer APIs"?

Here's what it looks like right now:
image

Copy link
Contributor Author

@mgchoi239 mgchoi239 Jan 18, 2026

Choose a reason for hiding this comment

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

Ack, updated. Qq, Is there a convenient way to render the sphinx changes?

Copy link
Member

@bveeramani bveeramani Jan 18, 2026

Choose a reason for hiding this comment

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

Eh...there's https://docs.ray.io/en/latest/ray-contribute/docs.html#building-the-ray-documentation, but Sphinx overall is kinda clunky

[Data][Docs] Sort references in Loading data and Saving data referenc…
1e3892a 
…es (ray-project#60084)

Categorize APIs into Public APIs and Developer APIs, and sort them alphabetically.

Changes:
- Reorganized loading_data.rst and saving_data.rst with Public APIs first, then Developer APIs with respective Headings
- Sorted all APIs alphabetically by service name within each section
- Split sections with both Public and Developer APIs (Arrow, NumPy, Pandas) into separate sections in both loading_data.rst and saving_data.rst

Signed-off-by: mgchoi239 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@bveeramani bveeramani bveeramani left review comments

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

community-contribution Contributed by the community data Ray Data-related issues docs An issue or change related to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[Data][Docs] Sort references in "Loading data" and "Saving data" references

2 participants

@mgchoi239 @bveeramani