chore(sdk): improve KFP SDK reference documentation #8337
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
|
Skipping CI for Draft Pull Request. |
connor-mccarthy
force-pushed
the
sdk-ref-docs-improvements
branch
from
8f9a231 to
2799632
Compare
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: chensun The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
jlyaoyuli
pushed a commit
to jlyaoyuli/pipelines
that referenced
this pull request
Jan 5, 2023
* use autodoc default options * sort symbol order by typical usage patterns * include summary of submodule symbols * expose Input[] and Output[] type generics * include tables of contents on API reference docs pages * expand global TOC for discoverability * fix missing reference / circular import problem
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.
Description of your changes:
I intended to add symbol-level permalinks to the documentation and
happened upon several other opportunities for improvements. In total, this
PR:
similar to how this is done in the "On this page" part of tensorflow
reference docs
autodocautomatically,rather than previously explicit inclusion, allowing for inclusion in summaries
(previously collapsed under top-level content items)
Checklist:
convention. Learn more about the pull request title convention used in this repository.