diff options
author | Quentin Schulz <foss@0leil.net> | 2021-04-07 18:07:24 +0200 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2021-04-09 15:24:46 +0100 |
commit | c380ba5a177de32e97820279685c4af6f837c010 (patch) | |
tree | c494289cda99f5bb76bad0d9492a3d1104d176d4 /documentation/README | |
parent | 802ac0b75e42657c7ff9f4ff5b2816c65ad29eea (diff) | |
download | poky-c380ba5a177de32e97820279685c4af6f837c010.tar.gz |
docs: replace anchor links
Anchor links are treated by Sphinx as external links and are not checked
during build, meaning it is impossible to know if a link becomes broken or
not.
As a matter of fact, most of the anchor links replaced in this commit
were actually broken.
The README now states that anchor links are forbidden so that there's no
need to go through such a change later on.
(From yocto-docs rev: de9e4d26b46afa3c79137d07529a74553400d2e0)
Signed-off-by: Quentin Schulz <foss@0leil.net>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/README')
-rw-r--r-- | documentation/README | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/documentation/README b/documentation/README index b491e46a1d..176c6db35b 100644 --- a/documentation/README +++ b/documentation/README | |||
@@ -259,6 +259,9 @@ websites. | |||
259 | More information can be found here: | 259 | More information can be found here: |
260 | https://sublime-and-sphinx-guide.readthedocs.io/en/latest/references.html. | 260 | https://sublime-and-sphinx-guide.readthedocs.io/en/latest/references.html. |
261 | 261 | ||
262 | Anchor (<#link>) links are forbidden as they are not checked by Sphinx during | ||
263 | the build and may be broken without knowing about it. | ||
264 | |||
262 | References | 265 | References |
263 | ========== | 266 | ========== |
264 | 267 | ||