File tree Expand file tree Collapse file tree 1 file changed +6
-3
lines changed
Expand file tree Collapse file tree 1 file changed +6
-3
lines changed Original file line number Diff line number Diff line change @@ -28,7 +28,7 @@ attribute definitions ``.. attribute: `attr-name``` :ref:`inform
2828attribute references ``:attr:`attr-name` `` :ref: `roles `
2929reference labels ``.. _label-name: `` :ref: `doc-ref-role `
3030internal references ``:ref:`label-name` `` :ref: `doc-ref-role `
31- external links ```Link text <https://example.com>`_ `` :ref: `hyperlinks `
31+ external links ```Link text <https://example.com>`__ `` :ref: `hyperlinks `
3232roles w/ custom text ``:role:`custom text <target>` `` :ref: `roles `
3333roles w/ only last part ``:role:`~hidden.hidden.visible` `` :ref: `roles `
3434roles w/o link ``:role:`!target` `` :ref: `roles `
@@ -185,9 +185,12 @@ Hyperlinks
185185External links
186186^^^^^^^^^^^^^^
187187
188- Use ```Link text <http ://target>`_ `` for inline web links. If the link text
188+ Use ```Link text <https ://example.com>`__ `` for inline web links. If the link text
189189should be the web address, you don't need special markup at all, the parser
190- finds links and mail addresses in ordinary text.
190+ finds links and mail addresses in ordinary text. Prefer anonymous hyperlinks
191+ (with a double underscore) over named hyperlinks (with a single underscore)
192+ to avoid target name clashes.
193+
191194
192195Internal links
193196^^^^^^^^^^^^^^
You can’t perform that action at this time.
0 commit comments