diff options
Diffstat (limited to 'documentation/README')
-rw-r--r-- | documentation/README | 10 |
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 | |||
314 | Anchor (<#link>) links are forbidden as they are not checked by Sphinx during | 314 | Anchor (<#link>) links are forbidden as they are not checked by Sphinx during |
315 | the build and may be broken without knowing about it. | 315 | the build and may be broken without knowing about it. |
316 | 316 | ||
317 | It is also possible to refer to another document within yocto-docs with the | ||
318 | :doc: directive (c.f. | ||
319 | https://www.sphinx-doc.org/en/master/usage/referencing.html#role-doc), e.g.: | ||
320 | |||
321 | For more information, read :doc:`/bsp-guide/index`. | ||
322 | |||
323 | Note that only "absolute" paths (starting with a '/') are allowed. The root | ||
324 | directory of that path is documentation/, that is, :doc:`/bsp-guide/index` | ||
325 | points at documentation/bsp-guide/index.rst. | ||
326 | |||
317 | References | 327 | References |
318 | ========== | 328 | ========== |
319 | 329 | ||