Skip to content

update onnxruntime docs, sync CANN quick start from upstream at build…#113

Merged
zheliuyu merged 1 commit intoAscend:mainfrom
bachelor-dou:add
Mar 19, 2026
Merged

update onnxruntime docs, sync CANN quick start from upstream at build…#113
zheliuyu merged 1 commit intoAscend:mainfrom
bachelor-dou:add

Conversation

@bachelor-dou
Copy link
Contributor

Summary

This PR adds ONNX Runtime-specific documentation sync so the CANN quick start stays aligned with upstream automatically during docs build.

Changes

  • Added a dedicated ONNX Runtime sync target (sync-onnxruntime-doc) in build flow.
  • Fetches latest official CANN Execution Provider quick-start markdown during build.
  • Uses generated docs path for synced ONNX Runtime quick-start content.
  • Updated ONNX Runtime quick-start entry/link to point to generated synced output.
  • Removed the locally maintained ONNX Runtime quick-start source to prevent content drift.
  • Added a minimal ONNX Runtime quickstart readability enhancement hook.

Why

Manual maintenance caused drift from upstream and created extra update overhead.
Build-time sync keeps ONNX Runtime quick-start content current with minimal maintenance.

Scope

Only ONNX Runtime quick-start documentation flow is affected.
No functional changes to other project docs.

@ascend-robot
Copy link

CLA Signature Pass

bachelor-dou, thanks for your pull request. All authors of the commits have signed the CLA. 👍


install.rst
quick_start.rst
../_generated/sources/onnxruntime/quick_start
Copy link
Collaborator

@zheliuyu zheliuyu Mar 16, 2026

Choose a reason for hiding this comment

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

After running make, I encountered the following error. It could be an issue with the specified path or a problem with the build files. I'll try again later.

image

Copy link
Collaborator

@zheliuyu zheliuyu Mar 17, 2026

Choose a reason for hiding this comment

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

After rebuilding, it appears that the automatic documentation generation is unaffected.

image

@zheliuyu zheliuyu merged commit 627597b into Ascend:main Mar 19, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants