-
Notifications
You must be signed in to change notification settings - Fork 98
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.
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
#11531: Autogenerate API rst stub files, add summary table on API page #12075
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
yan-zaretskiy
force-pushed
the
yan-zaretskiy/11531-op-autodoc
branch
3 times, most recently
from
August 30, 2024 20:02
86b9898
to
fce4afc
Compare
yan-zaretskiy
requested review from
eyonland,
arakhmati,
patrickroberts,
cfjchu,
xanderchin,
ayerofieiev-tt,
razorback3,
dongjin-na,
TT-BrianLiu,
dmakoviichuk-tt and
tt-rkim
as code owners
August 30, 2024 20:02
yan-zaretskiy
changed the title
#11531: WIP
#11531: Autogenerate API rst stub files, add summary table on API page
Aug 30, 2024
yan-zaretskiy
temporarily deployed
to
production
August 30, 2024 20:46 — with
GitHub Actions
Inactive
yan-zaretskiy
temporarily deployed
to
production
August 30, 2024 20:46 — with
GitHub Actions
Inactive
5 tasks
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.
Ticket
#11531
Problem description
Presently, we have to create an individual
.rst
file for every op we want to list in the Sphinx documentation. This creates unnecessary friction to adding documentation.What's changed
autosummary
directive to auto-generate rst files for us. This requires us to write an extension that knows how to documentFastOperation
instances automatically.Checklist