Skip to content
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
merged 6 commits into from
Sep 24, 2024

Conversation

yan-zaretskiy
Copy link
Contributor

@yan-zaretskiy yan-zaretskiy commented Aug 29, 2024

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

  • We use Sphinx's autosummary directive to auto-generate rst files for us. This requires us to write an extension that knows how to document FastOperation instances automatically.
  • We also remove manual function signatures from all op bindings. This was done so that those signatures get injected into the op documentation. The downside is that we have to make sure that the signature and individual attribute descriptions are in sync (there are currently not), and also it does not play well with the autosummary's generated table on the API page.
  • This PR requires that we follow the Google docstring style for documenting ops. It will be merged when all ops have been migrated.

Checklist

  • Post commit CI passes

@yan-zaretskiy yan-zaretskiy force-pushed the yan-zaretskiy/11531-op-autodoc branch 3 times, most recently from 86b9898 to fce4afc Compare August 30, 2024 20:02
@yan-zaretskiy yan-zaretskiy marked this pull request as ready for review August 30, 2024 20:02
@yan-zaretskiy yan-zaretskiy changed the title #11531: WIP #11531: Autogenerate API rst stub files, add summary table on API page Aug 30, 2024
@bharane-ab bharane-ab merged commit ce5c333 into main Sep 24, 2024
166 of 171 checks passed
@bharane-ab bharane-ab deleted the yan-zaretskiy/11531-op-autodoc branch September 24, 2024 13:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.