CI Make templated rst files clickable in the check rendered doc action #29948
Conversation
|
The working link can be seen in this previous build https://output.circle-artifacts.com/output/job/0315fdb6-151a-43f1-8c56-1b591afaf6ab/artifacts/0/doc/_changed.html (where I added a temporary change in a .template file). |
|
The fix is simple enough so I think it's worth merging it as is, but in the future I might consider reimplementing this script as a python script which I think will ease its maintenance. |
There was a problem hiding this comment.
LGTM, thanks @jeremiedbb!
The fix is simple enough so I think it's worth merging it as is, but in the future I might consider reimplementing this script as a python script which I think will ease its maintenance.
Indeed and it would be hard to implement more complicated logic in bash script. For instance the doc/api/module.rst.template template is actually mapped to actual module pages rather than doc/api/module.rst, for this we may want to import from doc/conf.py and use a Python script to do more complex things. I don't think we need to take this into account in the current PR though.
|
Merging, thanks! |
Changes to
.rst.templatefiles can't be directly checked in the check rendered doc action because the script in charge of generating the_changed.htmlfile creates broken links. This PR extends the existing logic to handle.rst.templatefiles.cc/ @lesteve @Charlie-XIAO