mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-05-04 13:39:49 +02:00
Code Issues Packages Projects Releases Wiki Activity

Documentation/README: formalize guidelines for external link syntax

Browse Source 
(From yocto-docs rev: f5d10ceed943270d7bcfa31b5936f37a60669c7f)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Michael Opdenacker
2022-10-27 11:46:21 +02:00
committed by Richard Purdie
parent e12050dcad
commit bb3fc03ef1
1 changed files with 13 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
documentation/README
View File

@@ -275,6 +275,19 @@ websites.
More information can be found here: More information can be found here:
https://sublime-and-sphinx-guide.readthedocs.io/en/latest/references.html. https://sublime-and-sphinx-guide.readthedocs.io/en/latest/references.html.
For external links, we use this syntax:
`link text <link URL>`__
instead of:
`link text <link URL>`_
Both syntaxes work, but the latter also creates a "link text" reference
target which could conflict with other references with the same name.
So, only use this variant when you wish to make multiple references
to this link, reusing only the target name.
See https://stackoverflow.com/questions/27420317/restructured-text-rst-http-links-underscore-vs-use
Anchor (<#link>) links are forbidden as they are not checked by Sphinx during Anchor (<#link>) links are forbidden as they are not checked by Sphinx during
the build and may be broken without knowing about it. the build and may be broken without knowing about it.