Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

RST link with replace not handled properly #1799

Open
fmigneault opened this issue Apr 5, 2024 · 2 comments
Open

RST link with replace not handled properly #1799

fmigneault opened this issue Apr 5, 2024 · 2 comments

Comments

@fmigneault
Copy link

fmigneault commented Apr 5, 2024

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)

|ogc-api-proc-part2|

.. |ogc-api-proc-part2| replace:: `OGC API - Processes - Part 2: Deploy, Replace, Undeploy`_ (DRU) extension
.. _`OGC API - Processes - Part 2: Deploy, Replace, Undeploy`: https://github.com/opengeospatial/ogcapi-processes/tree/master/extensions/deploy_replace_undeploy

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

image

The same link rendered by Sphinx and posted on ReadTheDocs is valid:
https://pavics-weaver.readthedocs.io/en/latest/#extra-details-sponsors

image

Case 2 - Link applied on replaced content

(source: https://github.com/crim-ca/weaver/blob/ee70c772dd860fdeb569bf1f87b946c76809e08a/README.rst?plain=1#L327-L328)

|ogc-eo-apps-pilot-er|_

.. |ogc-eo-apps-pilot-er| replace:: OGC Earth Observation Applications Pilot: CRIM Engineering Report
.. _ogc-eo-apps-pilot-er: http://docs.opengeospatial.org/per/20-045.html

Link not rendered on GitHub:
image

Works on ReadTheDocs:
image

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)

|ogc-proc-long|

.. |ogc-api-proc| replace:: `OGC API - Processes`
.. _ogc-api-proc: https://github.com/opengeospatial/ogcapi-processes
.. |ogc-proc-long| replace:: |ogc-api-proc|_ (WPS-REST bindings)

Link not rendered on GitHub:
image

Works on ReadTheDocs:
image

@TDKorn
Copy link

TDKorn commented Apr 7, 2024

@mentalisttraceur
Copy link

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.

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

No branches or pull requests

3 participants