Use anonymous references for links with embedded URLs (#13615)

Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
This commit is contained in:
Tim HoffmannandAdam Turner authored and GitHub committed 2025-06-07 17:07:52 +01:00
1 parent dc33f988f3
commit 74627b25b0
1 file changed
+32 -4
+32 -4
View File
@@ -208,11 +208,39 @@ Hyperlinks
External links
~~~~~~~~~~~~~~
Use ```Link text <https://domain.invalid/>`_`` for inline web links. If the
link text should be the web address, you don't need special markup at all, the
parser finds links and mail addresses in ordinary text.
URLs and email addresses in text are automatically linked and do not need
explicit markup at all.
For example, https://domain.invalid/ is written with no special markup
in the source of this document, and is recognised as an external hyperlink.
.. important:: There must be a space between the link text and the opening \< for the URL.
To create text with a link, the best approach is generally to put the URL
below the paragraph as follows (:duref:`ref <hyperlink-targets>`)::
This is a paragraph that contains `a link`_.
.. _a link: https://domain.invalid/
This keeps the paragraph more readable in source code.
Alternatively, you can embed the URL within the prose for an 'inline link'.
This can lead to longer lines, but has the benefit of keeping the link text
and the URL pointed to in the same place.
This uses the following syntax: ```Link text <https://domain.invalid/>`__``
(:duref:`ref <embedded-uris-and-aliases>`).
.. important::
There must be a space between the link text
and the opening angle bracket ('``<``') for the URL.
.. tip::
Use two trailing underscores when embedding the URL.
Technically, a single underscore works as well,
but that would create a named reference instead of an anonymous one.
Named references typically do not have a benefit when the URL is embedded.
Moreover, they have the disadvantage that you must make sure that you
do not use the same "Link text" for another link in your document.
You can also separate the link and the target definition (:duref:`ref
<hyperlink-targets>`), like this::