Skip to content

[DOC] Add extension APIs to runtime API reference#19385

Merged
GregoryComer merged 1 commit intopytorch:mainfrom
ymrohit:docathon-19348-runtime-extension-api
May 9, 2026
Merged

[DOC] Add extension APIs to runtime API reference#19385
GregoryComer merged 1 commit intopytorch:mainfrom
ymrohit:docathon-19348-runtime-extension-api

Conversation

@ymrohit
Copy link
Copy Markdown
Contributor

@ymrohit ymrohit commented May 8, 2026

Fixes #19348

Summary

  • Add extension/module and extension/tensor headers to the Doxygen inputs used by the runtime API reference.
  • Expand the module namespace macros so Breathe can resolve the documented extension classes with stable namespace names.
  • Add runtime API reference sections for Module, BundledModule, and the tensor extension namespace.

Test plan

  • git diff --check origin/main..HEAD
  • python -m py_compile docs/source/conf.py
  • cd docs && doxygen source/Doxyfile
  • Isolated Breathe/Sphinx build of executorch-runtime-api-reference.rst against the generated Doxygen XML
  • Verified the rendered runtime API page contains the new Module Extension and Tensor Extension entries

cc @mergennachin @AlannaBurke

@ymrohit ymrohit requested a review from mergennachin as a code owner May 8, 2026 00:20
@pytorch-bot
Copy link
Copy Markdown

pytorch-bot Bot commented May 8, 2026

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/executorch/19385

Note: Links to docs will display an error until the docs builds have been completed.

⏳ No Failures, 68 Pending, 1 Unclassified Failure

As of commit 0d7aebd with merge base 91aef57 (image):
💚 Looks good so far! There are no failures yet. 💚

UNCLASSIFIED FAILURE - DrCI could not classify the following job because the workflow did not run on the merge base. The failure may be pre-existing on trunk or introduced by this PR:

  • periodic (gh) (this job did not run on the merge base, so DrCI cannot tell whether the failure is pre-existing)

This comment was automatically generated by Dr. CI and updates every 15 minutes.

@meta-cla meta-cla Bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label May 8, 2026
@ymrohit
Copy link
Copy Markdown
Contributor Author

ymrohit commented May 8, 2026

@pytorchbot label "release notes: none"

@pytorch-bot pytorch-bot Bot added the release notes: none Do not include this in the release notes label May 8, 2026
Copy link
Copy Markdown
Member

@GregoryComer GregoryComer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. Thanks for the contribution!

@GregoryComer GregoryComer merged commit 4413a5c into pytorch:main May 9, 2026
173 of 177 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. release notes: none Do not include this in the release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add extension/tensor and module API docs to runtime API reference

3 participants