Skip to content

Commit dd3100c

Browse files
committed
docs: explain local rendered checks for unpublished commits
Signed-off-by: Ralf W. Grosse-Kunstleve <[email protected]>
1 parent 9b28ebc commit dd3100c

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

‎ci/README.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,20 @@ validation explicitly:
138138
git config lychee.repository NVIDIA/cuda-python
139139
```
140140

141+
For rendered checks of an unpublished local commit, select your fork's identity
142+
to validate source links against local files:
143+
144+
```bash
145+
git config lychee.repository YOUR_GITHUB_USER/cuda-python
146+
```
147+
148+
Use your actual fork's owner and repository. Set this before both the checking
149+
documentation build and the rendered hook; rebuild existing checking output if
150+
its example links contain an unpublished SHA. Clear any explicit
151+
`CUDA_PYTHON_DOCS_GITHUB_REF` override to use this selection. Only GitHub
152+
source-view fragments are omitted; generated HTML anchors remain checked.
153+
CI uses `GITHUB_REPOSITORY` and retains its normal validation policy.
154+
141155
The checking build uses the public checkout's actual commit for generated
142156
example links. In other repositories it uses `main`, allowing those public URLs
143157
to receive the same local target checks without inserting another repository's

0 commit comments

Comments
 (0)