Skip to content

Update build from source docs #13210

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

GregoryComer
Copy link
Member

@GregoryComer GregoryComer commented Aug 8, 2025

Summary

Overhaul the "Building from Source" doc page. The primarily intent of these changes is to document CMake presets and the various build options that we expose. However, I also did a pass on the existing contents of the file to improve formatting and clarity.

I've re-organized the page to clearly delineate environment setup, python install, and native build. It should flow better and be easier to read.

Test plan

I have built the docs locally to inspect the contents for formatting and correctness.

Preview page: https://docs-preview.pytorch.org/pytorch/executorch/13210/using-executorch-building-from-source.html
Live page (for comparison): https://docs.pytorch.org/executorch/0.7/using-executorch-building-from-source.html

Copy link

pytorch-bot bot commented Aug 8, 2025

🔗 Helpful Links

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

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

❌ 2 New Failures, 1 Unrelated Failure

As of commit a57b89f with merge base d118a63 (image):

NEW FAILURES - The following jobs have failed:

FLAKY - The following job failed but was likely due to flakiness present on trunk:

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 Aug 8, 2025
@GregoryComer GregoryComer added the release notes: none Do not include this in the release notes label Aug 8, 2025
@GregoryComer
Copy link
Member Author

GregoryComer commented Aug 8, 2025

Closes #13196.

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.

1 participant