[2.3.0][Tune][Doc] Restructure API reference #32449
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
justinvyu
requested review from
richardliaw,
gjoliver,
krfricke,
xwjiang2010,
amogkam,
matthewdeng,
Yard1,
maxpumperla and
a team
as code owners
|
Thanks @justinvyu ! Let's wait until #32446 is merged. |
cadedaniel
approved these changes
Feb 10, 2023
|
Ready for approval @zhe-thoughts. Not blocking the release test run today. |
cadedaniel
requested changes
Feb 11, 2023
| @@ -119,6 +119,7 @@ scripts/nodes.txt | |||
| /doc/_build | |||
| /doc/source/_static/thumbs | |||
| /doc/source/tune/generated_guides/ | |||
| /doc/source/**/doc/ | |||
There was a problem hiding this comment.
@justinvyu can you explain why this is necessary?
There was a problem hiding this comment.
We now have autogenerated API files under /doc/source/tune/api/doc/*, /doc/source/data/api/doc/*, etc. We shouldn't track these with git.
cadedaniel
approved these changes
Feb 11, 2023
Signed-off-by: Justin Yu <[email protected]>
|
Note: I had to make another commit removing a reference to an API that has landed in master but not 2.3.0. |
|
cc @zhe-thoughts merging this doc change in now |
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.
Why are these changes needed?
Cherry pick of #32311 and #32442 (fixed link check errors from the 1st PR).
This PR splits up long API refs into individual pages, one dedicated to each method/class. There are now 3 layers: an index page (ex:
doc/tune/api/api.rst), a summary page for each group of APIs (ex:doc/tune/api/trainable.rst), and an individual page for each API (ex:doc/tune/api/docs/tune.Trainable.rst).Related issue number
Checks
git commit -s) in this PR.scripts/format.shto lint the changes in this PR.