diff options
author | Nicolas Dechesne <nicolas.dechesne@linaro.org> | 2020-07-30 11:00:01 +0200 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2020-09-17 10:09:34 +0100 |
commit | 283ed72d487ed78d4f8e0fcc17f635d6c212b7c6 (patch) | |
tree | ee9bc44a1a2789a729632f4c0c436257fa477b8e /documentation/ref-manual/resources.rst | |
parent | 26c5622bb5551e1ad61db1c20890579dfb6b87c2 (diff) | |
download | poky-283ed72d487ed78d4f8e0fcc17f635d6c212b7c6.tar.gz |
sphinx: add links for Yocto project website
In DocBook, variables are used to create custom links (note that it is
not consistent everywhere, since some web addresses are still
hardcoded), such as YOCTO_HOME_URL, YOCTO_GIT_URL, YOCTO_WIKI_URL,
YOCTO_BUGS_URL and YOCTO_DL_URL..
In Sphinx they are replaced with extlinks.
(From yocto-docs rev: d25f3095a9d29a3355581d0743f27b2a423ad580)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual/resources.rst')
-rw-r--r-- | documentation/ref-manual/resources.rst | 20 |
1 files changed, 8 insertions, 12 deletions
diff --git a/documentation/ref-manual/resources.rst b/documentation/ref-manual/resources.rst index 50f2afae03..b443cbfb79 100644 --- a/documentation/ref-manual/resources.rst +++ b/documentation/ref-manual/resources.rst | |||
@@ -33,7 +33,7 @@ Yocto Project Bugzilla | |||
33 | ====================== | 33 | ====================== |
34 | 34 | ||
35 | The Yocto Project uses its own implementation of | 35 | The Yocto Project uses its own implementation of |
36 | `Bugzilla <&YOCTO_BUGZILLA_URL;>`__ to track defects (bugs). | 36 | :yocto_bugs:`Bugzilla <>` to track defects (bugs). |
37 | Implementations of Bugzilla work well for group development because they | 37 | Implementations of Bugzilla work well for group development because they |
38 | track bugs and code changes, can be used to communicate changes and | 38 | track bugs and code changes, can be used to communicate changes and |
39 | problems with developers, can be used to submit and review patches, and | 39 | problems with developers, can be used to submit and review patches, and |
@@ -52,11 +52,9 @@ against the Yocto Project, see the following: | |||
52 | Project <&YOCTO_DOCS_DEV_URL;#submitting-a-defect-against-the-yocto-project>`__" | 52 | Project <&YOCTO_DOCS_DEV_URL;#submitting-a-defect-against-the-yocto-project>`__" |
53 | section in the Yocto Project Development Tasks Manual. | 53 | section in the Yocto Project Development Tasks Manual. |
54 | 54 | ||
55 | - The Yocto Project `Bugzilla wiki | 55 | - The Yocto Project :yocto_wiki:`Bugzilla wiki page </wiki/Bugzilla_Configuration_and_Bug_Tracking>` |
56 | page <&YOCTO_WIKI_URL;/wiki/Bugzilla_Configuration_and_Bug_Tracking>`__ | ||
57 | 56 | ||
58 | For information on Bugzilla in general, see | 57 | For information on Bugzilla in general, see http://www.bugzilla.org/about/. |
59 | ` <http://www.bugzilla.org/about/>`__. | ||
60 | 58 | ||
61 | .. _resources-mailinglist: | 59 | .. _resources-mailinglist: |
62 | 60 | ||
@@ -109,11 +107,10 @@ Links and Related Documentation | |||
109 | 107 | ||
110 | Here is a list of resources you might find helpful: | 108 | Here is a list of resources you might find helpful: |
111 | 109 | ||
112 | - `The Yocto Project website <&YOCTO_HOME_URL;>`__\ *:* The home site | 110 | - :yocto_home:`The Yocto Project Website <>`\ *:* The home site |
113 | for the Yocto Project. | 111 | for the Yocto Project. |
114 | 112 | ||
115 | - `The Yocto Project Main Wiki | 113 | - :yocto_wiki:`The Yocto Project Main Wiki Page </wiki/Main_Page>`\ *:* The main wiki page for |
116 | Page <&YOCTO_WIKI_URL;/wiki/Main_Page>`__\ *:* The main wiki page for | ||
117 | the Yocto Project. This page contains information about project | 114 | the Yocto Project. This page contains information about project |
118 | planning, release engineering, QA & automation, a reference site map, | 115 | planning, release engineering, QA & automation, a reference site map, |
119 | and other resources related to the Yocto Project. | 116 | and other resources related to the Yocto Project. |
@@ -182,12 +179,12 @@ Here is a list of resources you might find helpful: | |||
182 | the :term:`OpenEmbedded Build System`, which uses | 179 | the :term:`OpenEmbedded Build System`, which uses |
183 | BitBake, that reports build information. | 180 | BitBake, that reports build information. |
184 | 181 | ||
185 | - `FAQ <&YOCTO_WIKI_URL;/wiki/FAQ>`__\ *:* A list of commonly asked | 182 | - :yocto_wiki:`FAQ </wiki/FAQ>`\ *:* A list of commonly asked |
186 | questions and their answers. | 183 | questions and their answers. |
187 | 184 | ||
188 | - *Release Notes:* Features, updates and known issues for the current | 185 | - *Release Notes:* Features, updates and known issues for the current |
189 | release of the Yocto Project. To access the Release Notes, go to the | 186 | release of the Yocto Project. To access the Release Notes, go to the |
190 | `Downloads <&YOCTO_HOME_URL;/software-overview/downloads/>`__ page on | 187 | :yocto_home:`Downloads </software-overview/downloads>` page on |
191 | the Yocto Project website and click on the "RELEASE INFORMATION" link | 188 | the Yocto Project website and click on the "RELEASE INFORMATION" link |
192 | for the appropriate release. | 189 | for the appropriate release. |
193 | 190 | ||
@@ -195,8 +192,7 @@ Here is a list of resources you might find helpful: | |||
195 | the Yocto Project uses. If you find problems with the Yocto Project, | 192 | the Yocto Project uses. If you find problems with the Yocto Project, |
196 | you should report them using this application. | 193 | you should report them using this application. |
197 | 194 | ||
198 | - `Bugzilla Configuration and Bug Tracking Wiki | 195 | - :yocto_wiki:`Bugzilla Configuration and Bug Tracking Wiki Page </wiki/Bugzilla_Configuration_and_Bug_Tracking>`\ *:* |
199 | Page <&YOCTO_WIKI_URL;/wiki/Bugzilla_Configuration_and_Bug_Tracking>`__\ *:* | ||
200 | Information on how to get set up and use the Yocto Project | 196 | Information on how to get set up and use the Yocto Project |
201 | implementation of Bugzilla for logging and tracking Yocto Project | 197 | implementation of Bugzilla for logging and tracking Yocto Project |
202 | defects. | 198 | defects. |