[data][doc] auto-generate dataset api documentation #46557
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
can-anyscale
force-pushed
the
can-docauto04
branch
from
a6f67c7
to
2cca635
Compare
can-anyscale
force-pushed
the
can-docauto04
branch
7 times, most recently
from
2953a9e
to
8f7a7ab
Compare
can-anyscale
changed the title
can-anyscale
commented
Jul 11, 2024
| @@ -1,4 +1,5 @@ | |||
| {{ name | escape | underline}} | |||
| {{ name }} | |||
| {{ '-' * name | length }} | |||
There was a problem hiding this comment.
change to H2 instead of H1 header type
| @@ -401,7 +401,10 @@ def get_api_groups(method_names, class_name, module_name): | |||
| cls = getattr(import_module(module_name), class_name) | |||
| for method_name in method_names: | |||
| method = getattr(cls, method_name) | |||
| api_groups.add(safe_getattr(method, "_annotated_api_group", DEFAULT_API_GROUP)) | |||
| if _is_public_api(method): | |||
There was a problem hiding this comment.
only need to get api group from public APIs
| @@ -1,3 +1,6 @@ | |||
| .. _dataset-iterator-api: | |||
|
|
|||
| DataIterator API | |||
There was a problem hiding this comment.
to be consistent with how dataset api is documented
|
|
||
| if "stability" in kwargs: | ||
| stability = kwargs["stability"] | ||
| assert stability in ["stable", "beta", "alpha"], stability | ||
| elif kwargs: |
There was a problem hiding this comment.
remove this condition since the key can also be api_group (in addition to stability)
Signed-off-by: can <can@anyscale.com>
can-anyscale
force-pushed
the
can-docauto04
branch
from
8f7a7ab
to
bb122d8
Compare
can-anyscale
requested review from
ericl,
scv119,
c21,
amogkam,
scottjlee,
bveeramani,
raulchen,
stephanie-wang,
omatthew98 and
a team
as code owners
Catch-Bull
pushed a commit
to Catch-Bull/ray
that referenced
this pull request
Jul 15, 2024
This PR auto-generate dataset API documentation, by moving the declaration of API group to the code itself. Also few other fixes to bring consistency between pages. Test: - dataset page: https://anyscale-ray--46557.com.readthedocs.build/en/46557/data/api/dataset.html - navigation page: https://anyscale-ray--46557.com.readthedocs.build/en/46557/data/api/api.html Note that the documentation is now consistently documenting a class construction in its full form Signed-off-by: can <can@anyscale.com> Signed-off-by: hejialing.hjl <hejialing.hjl@bytedance.com>
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.
This PR auto-generate dataset API documentation, by moving the declaration of API group to the code itself. Also few other fixes to bring consistency between pages.
Test:
Note that the documentation is now consistently documenting a class construction in its full form