summaryrefslogtreecommitdiffstats
path: root/documentation/README
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/README')
-rw-r--r--documentation/README10
1 files changed, 10 insertions, 0 deletions
diff --git a/documentation/README b/documentation/README
index 02037e0f7e..56eac7ca19 100644
--- a/documentation/README
+++ b/documentation/README
@@ -314,6 +314,16 @@ See https://stackoverflow.com/questions/27420317/restructured-text-rst-http-link
314Anchor (<#link>) links are forbidden as they are not checked by Sphinx during 314Anchor (<#link>) links are forbidden as they are not checked by Sphinx during
315the build and may be broken without knowing about it. 315the build and may be broken without knowing about it.
316 316
317It is also possible to refer to another document within yocto-docs with the
318:doc: directive (c.f.
319https://www.sphinx-doc.org/en/master/usage/referencing.html#role-doc), e.g.:
320
321 For more information, read :doc:`/bsp-guide/index`.
322
323Note that only "absolute" paths (starting with a '/') are allowed. The root
324directory of that path is documentation/, that is, :doc:`/bsp-guide/index`
325points at documentation/bsp-guide/index.rst.
326
317References 327References
318========== 328==========
319 329