diff options
author | Nicolas Dechesne <nicolas.dechesne@linaro.org> | 2020-12-03 22:38:35 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2020-12-09 12:21:27 +0000 |
commit | 097d0c9f04353866302efebcdd0b497c2b89cabb (patch) | |
tree | 305ac5b0776eb37623a9be99a81bee3434a5e4a9 /documentation/dev-manual/dev-manual-intro.rst | |
parent | bd1789261122c25d62b8e8e7f7d5647249e8d8ff (diff) | |
download | poky-097d0c9f04353866302efebcdd0b497c2b89cabb.tar.gz |
sphinx: use absolute paths for :doc: references
:doc: references can be made with absolute path instead of relative
path. This patch was generated with this command:
sed -i 's!:doc:`\.\./!:doc:`/!g' */*.rst *.rst
And a few manual fixup we made for references such as:
:doc:"FOOBAR <../xxx>"
Suggested-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: b7948ec7eb8172b8eae4bfa5c21aab76e123ad85)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/dev-manual/dev-manual-intro.rst')
-rw-r--r-- | documentation/dev-manual/dev-manual-intro.rst | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/documentation/dev-manual/dev-manual-intro.rst b/documentation/dev-manual/dev-manual-intro.rst index 94c481b7d8..23c848e870 100644 --- a/documentation/dev-manual/dev-manual-intro.rst +++ b/documentation/dev-manual/dev-manual-intro.rst | |||
@@ -31,13 +31,13 @@ This manual provides the following: | |||
31 | This manual does not provide the following: | 31 | This manual does not provide the following: |
32 | 32 | ||
33 | - Redundant Step-by-step Instructions: For example, the | 33 | - Redundant Step-by-step Instructions: For example, the |
34 | :doc:`../sdk-manual/index` manual contains detailed | 34 | :doc:`/sdk-manual/index` manual contains detailed |
35 | instructions on how to install an SDK, which is used to develop | 35 | instructions on how to install an SDK, which is used to develop |
36 | applications for target hardware. | 36 | applications for target hardware. |
37 | 37 | ||
38 | - Reference or Conceptual Material: This type of material resides in an | 38 | - Reference or Conceptual Material: This type of material resides in an |
39 | appropriate reference manual. For example, system variables are | 39 | appropriate reference manual. For example, system variables are |
40 | documented in the :doc:`../ref-manual/index`. | 40 | documented in the :doc:`/ref-manual/index`. |
41 | 41 | ||
42 | - Detailed Public Information Not Specific to the Yocto Project: For | 42 | - Detailed Public Information Not Specific to the Yocto Project: For |
43 | example, exhaustive information on how to use the Source Control | 43 | example, exhaustive information on how to use the Source Control |
@@ -52,7 +52,7 @@ supplemental information is recommended for full comprehension. For | |||
52 | introductory information on the Yocto Project, see the | 52 | introductory information on the Yocto Project, see the |
53 | :yocto_home:`Yocto Project Website <>`. If you want to build an image with no | 53 | :yocto_home:`Yocto Project Website <>`. If you want to build an image with no |
54 | knowledge of Yocto Project as a way of quickly testing it out, see the | 54 | knowledge of Yocto Project as a way of quickly testing it out, see the |
55 | :doc:`../brief-yoctoprojectqs/index` document. | 55 | :doc:`/brief-yoctoprojectqs/index` document. |
56 | 56 | ||
57 | For a comprehensive list of links and other documentation, see the | 57 | For a comprehensive list of links and other documentation, see the |
58 | ":ref:`ref-manual/resources:links and related documentation`" | 58 | ":ref:`ref-manual/resources:links and related documentation`" |