tree-wide: make the :doc: directive use absolute paths

This makes all :doc: directives use an absolute paths (with the root
directory being documentation/ in the repo).

This is then consistent across the whole source and is easier to review
and move files around, you just need to know where a file is located
relative to documentation/ directory and use that.

This gets rid of paths looking in parent directory with '..' as well as
expecting a file to be in the same directory as the other file it points
to via the :doc: directive.

(From yocto-docs rev: b9457f2005b0bea49c54e9727eb30e9458084886)

Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Quentin Schulz
2025-06-18 17:13:35 +02:00
committed by Richard Purdie
parent 931db3845c
commit bebe66feae
14 changed files with 24 additions and 24 deletions

View File

@@ -23,7 +23,7 @@ The Yocto Project gladly accepts contributions. You can submit changes
to the project either by creating and sending pull requests, or by
submitting patches through email. For information on how to do both as
well as information on how to identify the maintainer for each area of
code, see the :doc:`../contributor-guide/index`.
code, see the :doc:`/contributor-guide/index`.
.. _resources-bugtracker:
@@ -45,7 +45,7 @@ your expectations).
For a general procedure and guidelines on how to use Bugzilla to submit a bug
against the Yocto Project, see the following:
- The ":doc:`../contributor-guide/report-defect`"
- The ":doc:`/contributor-guide/report-defect`"
section in the Yocto Project and OpenEmbedded Contributor Guide.
- The Yocto Project :yocto_wiki:`Bugzilla wiki page </Bugzilla_Configuration_and_Bug_Tracking>`

View File

@@ -145,7 +145,7 @@ tested on former revisions of "&DISTRO_NAME;", but no longer are:
interested in hearing about your experience. For information on
how to submit a bug, see the Yocto Project
:yocto_wiki:`Bugzilla wiki page </Bugzilla_Configuration_and_Bug_Tracking>`
and the ":doc:`../contributor-guide/report-defect`"
and the ":doc:`/contributor-guide/report-defect`"
section in the Yocto Project and OpenEmbedded Contributor Guide.
Required Packages for the Build Host

View File

@@ -2576,7 +2576,7 @@ system and gives an overview of their function and contents.
You can safely share this directory between multiple builds on the
same development machine. For additional information on how the build
process gets source files when working behind a firewall or proxy
server, see this specific question in the ":doc:`faq`"
server, see this specific question in the ":doc:`/ref-manual/faq`"
chapter. You can also refer to the
":yocto_wiki:`Working Behind a Network Proxy </Working_Behind_a_Network_Proxy>`"
Wiki page.