summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2022-10-27 11:46:21 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2022-10-28 15:48:03 +0100
commitbb3fc03ef167a005cdf1192df60ac2fb1cbc5ae3 (patch)
treebd267dad4ad629ad1afab9ca3dd36469a7c6ff05 /documentation
parente12050dcadde33073dc0af4f0d8432cc80f36e38 (diff)
downloadpoky-bb3fc03ef167a005cdf1192df60ac2fb1cbc5ae3.tar.gz
Documentation/README: formalize guidelines for external link syntax
(From yocto-docs rev: f5d10ceed943270d7bcfa31b5936f37a60669c7f) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/README13
1 files changed, 13 insertions, 0 deletions
diff --git a/documentation/README b/documentation/README
index 6333f0496a..c27ed86a33 100644
--- a/documentation/README
+++ b/documentation/README
@@ -275,6 +275,19 @@ websites.
275More information can be found here: 275More information can be found here:
276https://sublime-and-sphinx-guide.readthedocs.io/en/latest/references.html. 276https://sublime-and-sphinx-guide.readthedocs.io/en/latest/references.html.
277 277
278For external links, we use this syntax:
279`link text <link URL>`__
280
281instead of:
282`link text <link URL>`_
283
284Both syntaxes work, but the latter also creates a "link text" reference
285target which could conflict with other references with the same name.
286So, only use this variant when you wish to make multiple references
287to this link, reusing only the target name.
288
289See https://stackoverflow.com/questions/27420317/restructured-text-rst-http-links-underscore-vs-use
290
278Anchor (<#link>) links are forbidden as they are not checked by Sphinx during 291Anchor (<#link>) links are forbidden as they are not checked by Sphinx during
279the build and may be broken without knowing about it. 292the build and may be broken without knowing about it.
280 293