Skip to content

Feat/requirements from common - #6620

Draft
neon60 wants to merge 7 commits into
developfrom
feat/requirements-from-common
Draft

Feat/requirements from common#6620
neon60 wants to merge 7 commits into
developfrom
feat/requirements-from-common

Conversation

@neon60

@neon60 neon60 commented Aug 17, 2026

Copy link
Copy Markdown
Collaborator

Motivation

Technical Details

Test Plan

Test Result

Submission Checklist

@neon60
neon60 requested a review from alexxu-amd August 18, 2026 15:51

@alexxu-amd alexxu-amd left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks good. Minor point: once rocm-docs-common is ready, we can use tag instead of main for improved reproducibility.

neon60 and others added 7 commits August 28, 2026 12:35
Point docs/sphinx/requirements.txt at the pinned lockfile in
rocm-docs-common over HTTPS, so a local build needs no clone. A commented
local-path override is provided for building against a rocm-docs-common
checkout.

Co-Authored-By: Claude Opus 4 (1M context) <noreply@anthropic.com>
Pull the pinned Sphinx build dependencies (and the matching rocm-docs-core
branch) from the shared rocm-docs-common lockfile over HTTPS. Requirements
must be available at pip time, so they come from the URL rather than the
build-time common-data clone. Divergence is documented inline: comment the
-r URL and add local pins or point at a local checkout.

Co-Authored-By: Claude Opus 4 (1M context) <noreply@anthropic.com>
rocm-docs-core clones rocm-docs-common into the repo root at build time to
read shared data locally; keep that checkout out of version control.

Co-Authored-By: Claude Opus 4 (1M context) <noreply@anthropic.com>
Add a post_checkout job that clones rocm-docs-common before dependency
install, and point python.install at that checkout's Sphinx lockfile
instead of downloading it over HTTPS. rocm-docs-core reuses the same
clone for its shared data at build time.

Co-Authored-By: Claude Opus 4 (1M context) <noreply@anthropic.com>
…oint

Point .readthedocs.yaml at the repo's own docs/sphinx/requirements.txt and
have the post_checkout job rewrite its default HTTPS -r line to the cloned
rocm-docs-common lockfile, avoiding the HTTPS fetch on Read the Docs. A
customized requirements.txt (URL line removed) is left untouched and used
verbatim locally and on RTD.

Co-Authored-By: Claude Opus 4 (1M context) <noreply@anthropic.com>
Read the Docs executes each post_checkout job step under dash, which
mangled the multi-line if...fi literal block and failed with
"Syntax error: end of file unexpected (expecting \"fi\")". Collapse the
conditional onto one line so it runs correctly.

Co-Authored-By: Claude Opus 4 (1M context) <noreply@anthropic.com>
The one-line if...fi still failed under Read the Docs' shell with
"Syntax error: end of file unexpected (expecting \"fi\")", and the sed
used # as its delimiter, which the shell also mangled. Replace it with a
bare sed that uses @ as the delimiter and has no spaces in the
expression. It is a no-op when the default URL is absent, so a
customized requirements.txt is still left untouched, without needing a
conditional.

Co-Authored-By: Claude Opus 4 (1M context) <noreply@anthropic.com>
@neon60
neon60 force-pushed the feat/requirements-from-common branch from 44ba28f to 9bcbbe6 Compare August 28, 2026 10:54
@github-actions

Copy link
Copy Markdown
Contributor

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants