Skip to content

docs(android): add Java API Reference (Javadoc) link, sidebar entry, …#19508

Open
madhesh60 wants to merge 1 commit into
pytorch:mainfrom
madhesh60:docs/android-javadoc-fix
Open

docs(android): add Java API Reference (Javadoc) link, sidebar entry, …#19508
madhesh60 wants to merge 1 commit into
pytorch:mainfrom
madhesh60:docs/android-javadoc-fix

Conversation

@madhesh60
Copy link
Copy Markdown

@madhesh60 madhesh60 commented May 12, 2026

Summary

Fixes #19356 — Unify and Improve the Android dev story

Changes

  • Added Java API Reference (Javadoc) link to using-executorch-android page (1-line fix)
  • Added Javadoc entry to Android sidebar navigation
  • Created package-info.java for org.pytorch.executorch with overview and quick-start
  • Created package-info.java for org.pytorch.executorch.extension.llm
  • Created overview.html with top-level intro, quick-start code, and package descriptions
  • Updated build.gradle to pass -overview flag so overview.html is picked up by the build

Testing

All are verified by opening the documents manually.

  • Added a "Java API Reference" hyperlink directly in the using-executorch-android page → trivial 1-line fix
Screenshot 2026-05-12 124608
  • Added sidebar/nav entry under Platforms → Android → "Java API Reference (Javadoc)"
Screenshot 2026-05-12 124524
  • Improved the bare javadoc/index.html with an overview, quick-start code, and package descriptions
Screenshot 2026-05-12 124548

cc @mergennachin @AlannaBurke

@pytorch-bot
Copy link
Copy Markdown

pytorch-bot Bot commented May 12, 2026

🔗 Helpful Links

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

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

❗ 1 Active SEVs

There are 1 currently active SEVs. If your PR is affected, please view them below:

⚠️ 11 Awaiting Approval

As of commit 661de6f with merge base af90130 (image):

AWAITING APPROVAL - The following workflows need approval before CI can run:

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

@meta-cla
Copy link
Copy Markdown

meta-cla Bot commented May 12, 2026

Hi @madhesh60!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks!

@github-actions github-actions Bot added docathon-2026 easy Easy Difficulty for issues as part of PyTorch Docathon H1 2026 module: doc Issues related to documentation, both in docs/ and inlined in code labels May 12, 2026
@madhesh60
Copy link
Copy Markdown
Author

@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 12, 2026
@meta-cla
Copy link
Copy Markdown

meta-cla Bot commented May 12, 2026

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

@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 12, 2026
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. docathon-2026 easy Easy Difficulty for issues as part of PyTorch Docathon H1 2026 module: doc Issues related to documentation, both in docs/ and inlined in code release notes: none Do not include this in the release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Unify and Improve the Android dev story

2 participants