|
@@ -314,6 +314,16 @@ See https://stackoverflow.com/questions/27420317/restructured-text-rst-http-link
|
|
|
Anchor (<#link>) links are forbidden as they are not checked by Sphinx during
|
|
|
the build and may be broken without knowing about it.
|
|
|
|
|
|
+It is also possible to refer to another document within yocto-docs with the
|
|
|
+:doc: directive (c.f.
|
|
|
+https://www.sphinx-doc.org/en/master/usage/referencing.html#role-doc), e.g.:
|
|
|
+
|
|
|
+ For more information, read :doc:`/bsp-guide/index`.
|
|
|
+
|
|
|
+Note that only "absolute" paths (starting with a '/') are allowed. The root
|
|
|
+directory of that path is documentation/, that is, :doc:`/bsp-guide/index`
|
|
|
+points at documentation/bsp-guide/index.rst.
|
|
|
+
|
|
|
References
|
|
|
==========
|
|
|
|