doc: rm links to doc source; show links to github code source#1506
doc: rm links to doc source; show links to github code source#1506leondz merged 1 commit intoNVIDIA:mainfrom
Conversation
leondz
requested review from
aishwaryap,
erickgalinkin,
mikemckiernan,
parkanzky and
patriciapampanelli
mikemckiernan
left a comment
mikemckiernan
left a comment
There was a problem hiding this comment.
Yeah, copying the source of every file is kind of terrible.
This PR is more of a UX change - the default "view source" link pointed to the source of the RST-fornat documentation, and the change makes it point to the Python source code |
jmartin-tech
left a comment
jmartin-tech
left a comment
There was a problem hiding this comment.
This seems reasonable, is the project comfortable with local build of the doc source to have possibly invalid links to source? The build process uses the commit hash of the local commit as the resolved permalink and a local build done after local commits that have not been accepted upstream will produce links that 404 when followed.
|
It's a little smart - it even uses the most recent hash of the file being tested, rather than head, is what I believe was observed in validation |
4 participants
see title
example in practice:
("Source" here links to github / main branch)