Update documentation flow and add placeholders #8287
Merged
Conversation
This file contains hidden or 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
🔗 Helpful Links🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/executorch/8287
Note: Links to docs will display an error until the docs builds have been completed. This comment was automatically generated by Dr. CI and updates every 15 minutes. |
facebook-github-bot
added
the
CLA Signed
GregoryComer
force-pushed
the
doc-structure
branch
from
24fb19e to
ea59db3
Compare
GregoryComer
force-pushed
the
doc-structure
branch
2 times, most recently
from
dae67b0 to
270569a
Compare
byjlw
approved these changes
Feb 6, 2025
mergennachin
approved these changes
Feb 6, 2025
| @@ -0,0 +1,3 @@ | |||
| # ARM Backend | |||
There was a problem hiding this comment.
ARM -> Arm EthosU Backend
ARM is too broad... Is it Cortex-A, Cortex-M?
In this case, we're only talking about running on Cortex Ethos-U backend for acceleration.
docs/source/index.rst
Outdated
| .. toctree:: | ||
| :glob: | ||
| :maxdepth: 1 | ||
| :caption: Backend Delegates |
There was a problem hiding this comment.
Change to "Backends"
the reason is that Cadence is not really a delegate
| @@ -0,0 +1,3 @@ | |||
| # Qualcomm Backend | |||
|
|
|||
| Placeholder | |||
There was a problem hiding this comment.
Are you basically moving contents over from https://pytorch.org/executorch/stable/build-run-qualcomm-ai-engine-direct-backend.html to this? And do adjustments, along the way?
|
|
||
| .. toctree:: | ||
| :glob: | ||
| :maxdepth: 1 | ||
| :caption: Kernel Library | ||
| :caption: Backend Development |
| memory-planning-inspection | ||
| delegate-debugging | ||
| devtools-tutorial | ||
| compiler-delegate-and-partitioner |
There was a problem hiding this comment.
the first one can actually go to "Backend Development" section
| native-delegates-executorch-arm-delegate | ||
| native-delegates-executorch-qualcomm-delegate | ||
| native-delegates-executorch-mediatek-delegate | ||
| native-delegates-executorch-cadence-delegate | ||
|
|
||
| .. toctree:: |
There was a problem hiding this comment.
we have too many tutorials here
can we remove everything in Tutorials section, and gradually increase if necessary?
There was a problem hiding this comment.
Sounds good. I 100% agree on the tutorials. A lot of what's in there is really reference material and not a tutorial. I'm happy to remove them for now.
GregoryComer
force-pushed
the
doc-structure
branch
from
270569a to
f74a273
Compare
GregoryComer
added a commit
to GregoryComer/executorch
that referenced
this pull request
Feb 12, 2025
Add placeholder top-level doc pages
GregoryComer
added a commit
to GregoryComer/executorch
that referenced
this pull request
Feb 23, 2025
Add placeholder top-level doc pages
GregoryComer
added a commit
that referenced
this pull request
Feb 23, 2025
Add placeholder top-level doc pages
GregoryComer
added a commit
that referenced
this pull request
Feb 26, 2025
Add placeholder top-level doc pages
GregoryComer
added a commit
that referenced
this pull request
Feb 26, 2025
* New Getting Started documentation (#8179) WIP New getting started * Update documentation flow and add placeholders (#8287) Add placeholder top-level doc pages * Add new export + lowering docs, update getting started (#8412) Write new top-level export and lowering documentation * More doc placeholders (#8523) * Move cmake and faq docs to new location * Rename CMake build to Building from Source * Move backend docs to new locations (#8413) * Temporarily remove new backend pages * Move backend docs to new locations * Update backend titles and inline contents * Backend doc template (#8524) Add backend template, update XNNPACK docs * Add runtime integration documentation (#8516) Add runtime integration doc * Move iOS docs to top, add Android placeholders (#8511) * Temporarily remove using-executorch-ios.md * Move Apple runtime docs to new location * Clean up documentation placeholders and links, add top-level docs for C++ APIs, Android, and troubleshooting (#8618) * Clean up getting-started.md, remove placeholders * Move Android pre-built AAR info into top-level Android page * Add placeholder backend overview * Add placeholder troubleshooting docs * Populate top-level C++ API doc * Clean up additional doc placeholders and fix broken links * Add env setup instructions for source build * Fix getting started code snippet (#8637) Fix quotes in getting started code snippets * Clean up a few more doc sections and links (#8672) Clean up a few more broken links and sections in new doc flow * Fix QNN link, typo (#8729) * Add a CMake snippet to the XNNPACK backend doc build section (#8730) Add CMake example to xnnpack backend doc
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.
Summary
This PR makes some high-level updates to the documentation TOC layout and creates placeholders for a number of documentation pages. Most notably, the following has changed:
Test plan
Built docs locally and validated.