[docs] Add a unified APIs navigation section#64387
Draft
ronny-anyscale wants to merge 1 commit into
Draft
Conversation
Move each library's API reference (Data, Train, Tune, Serve, RLlib, Core) under a single apis/ tree, surfaced as an "APIs" top-nav tab. On any API page the left sidebar shows the API navigation scoped to the current library (with the current symbol anchored) instead of the narrative navigation. Adds a small Sphinx extension to scope the APIs sidebar to apis/ pages, short autosummary stub labels, and a MyST APIs landing page. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Signed-off-by: Ronny Roland <ronny.roland@anyscale.com>
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request restructures the API documentation by consolidating library APIs under a unified apis/ directory. It introduces a new Sphinx extension api_sidebar to scope the API sidebar to these pages, updates various autosummary templates to use shortened names, and updates internal links across the documentation to point to the new /apis/ paths. There are no review comments, so I have no feedback to provide.
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
1 participant
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.
What
Prototype of a unified APIs navigation section. Each library's API reference (Data, Train, Tune, Serve, RLlib, Core) moves under a single
apis/<lib>/tree, surfaced as an "APIs" item in the top navigation. On any API page the left sidebar shows the API navigation — scoped to the current library, with the current symbol anchored — instead of the library's narrative navigation.Why
Today every page renders the same global left nav. This makes the API reference a first-class, self-contained section with its own navigation, so navigating into a symbol (e.g.
Dataset.sum) keeps you in the API tree.How
git mveach library's API reference underapis/<lib>/; add a MySTapis/index.mdlanding page and an "APIs" top-nav entry; drop the API entry from each library's narrative toctree._ext/api_sidebar.py) scopes the APIs sidebar toapis/pages (orphan pages fall back to the global sidebar).Status / notes
make html -Wis clean locally (0 warnings)./<lib>/api/...→/apis/<lib>/...). Redirects for the old URLs are not included yet, and a few absolute deep-links in example notebooks still point at old paths (non-breaking) — follow-up.🤖 Generated with Claude Code