Issues

Issue #1191 new

Need documentation for link markup with i18n

Takayuki Shimizukawa
created an issue

Link markup with i18n strategy recommendation should be added somewhere in the sphinx documentation.

https://groups.google.com/d/msg/sphinx-dev/uLjb0B-J5r0/PY_9MKt6gG8J

>   Here's how you can `download Django`_.
>
>   .. _download Django: https://www.djangoproject.com/download/
>
> When translating, this is suboptimal, because if you translate "download
> Django" in the paragraph, the link is lost. So:
> 1. Is there a recommended practice about how to include i18n-friendly links
> in sphinx docs?

1a. Sphinx-1.2b1 already solved this problem.
However, if the two links with `title string`_ style are included in one sentence,
you can not change the order of the links in the translation.

1b. `download Django <link-target-url>`_ style link always work
(include Sphinx-1.1.x).

Comments (3)

  1. Log in to comment