Closed fmigneault closed 1 month ago
Same here (see https://github.com/orgs/community/discussions/114840)
By the way, in reST this is the only way to have formatting in links.
The above examples are all prose formatting, but this also breaks developer-centric stuff, like links to function/class/package documentation which mark the name as code
.
Stale issue message
This appears this has been fixed (at least case 2, I haven't checked the others).
I confirm that all 3 cases seem to be handled correctly at the time of this comment.
Summary
There are 3 use cases where RST
replace::
directive are not handled properly with links.All below examples use the following source for corresponding contents:
Case 1 - Embedded link in replace
Below is a replacement directive, which contains a link: (source: https://github.com/crim-ca/weaver/blob/ee70c772dd860fdeb569bf1f87b946c76809e08a/README.rst?plain=1#L331-L332)
When rendered by GitHub, a link is generated, but it does not resolve to the right location: https://github.com/crim-ca/weaver?tab=readme-ov-file#extra-details--sponsors
The same link rendered by Sphinx and posted on ReadTheDocs is valid: https://pavics-weaver.readthedocs.io/en/latest/#extra-details-sponsors
Case 2 - Link applied on replaced content
(source: https://github.com/crim-ca/weaver/blob/ee70c772dd860fdeb569bf1f87b946c76809e08a/README.rst?plain=1#L327-L328)
Link not rendered on GitHub:
Works on ReadTheDocs:
Case 3 - Mix of both previous link/replace in a nested fashion
(source: https://github.com/crim-ca/weaver/blob/ee70c772dd860fdeb569bf1f87b946c76809e08a/README.rst?plain=1#L308-L310)
Link not rendered on GitHub:
Works on ReadTheDocs: