summaryrefslogtreecommitdiff
path: root/poky/documentation/README
diff options
context:
space:
mode:
Diffstat (limited to 'poky/documentation/README')
-rw-r--r--poky/documentation/README5
1 files changed, 4 insertions, 1 deletions
diff --git a/poky/documentation/README b/poky/documentation/README
index 159ec9460..176c6db35 100644
--- a/poky/documentation/README
+++ b/poky/documentation/README
@@ -109,7 +109,7 @@ obvious reasons, we will only support building the Yocto Project
documentation with Python3.
Sphinx might be available in your Linux distro packages repositories,
-however it is not recommend to use distro packages, as they might be
+however it is not recommended to use distro packages, as they might be
old versions, especially if you are using an LTS version of your
distro. The recommended method to install Sphinx and all required
dependencies is to use the Python Package Index (pip).
@@ -259,6 +259,9 @@ websites.
More information can be found here:
https://sublime-and-sphinx-guide.readthedocs.io/en/latest/references.html.
+Anchor (<#link>) links are forbidden as they are not checked by Sphinx during
+the build and may be broken without knowing about it.
+
References
==========