linux/poky.git/documentation/sdk-manual, branch gatesgarth-24.0.2Mirror of git.yoctoproject.org/pokyhttps://git.enea.com/cgit/linux/poky.git/atom?h=gatesgarth-24.0.22020-10-20T10:12:06+00:00sdk-manual: use built-in footnotes2020-10-20T10:12:06+00:00Nicolas Dechesnenicolas.dechesne@linaro.org2020-10-09T17:23:17+00:00urn:sha1:9f8e2c0ea6a0f9de538a46ebbd94df609bee0dda
The current HTML output is bogus, because we have a fix of * and \.
Sphinx has built-in footnotes that can be used in this specific
example. let's use that instead.
(From yocto-docs rev: 5be36103ca1102c995915a20bf881e43920595e3)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
docs: Fix license CC-BY-2.0-UK -> CC-BY-SA-2.0-UK2020-10-08T10:28:30+00:00Richard Purdierichard.purdie@linuxfoundation.org2020-10-07T21:05:43+00:00urn:sha1:fe74a4edd2db299557c9c0ffb1a804da444c47bd
When the license identifier tags were added, an incorrect string was used
and the Share-Alike clause was lost. Fix this to match the license
description in the files and add back the lost piece (its clear from
the history it should be there)
(From yocto-docs rev: 8d30c3d792755a7bfdb74b331dad98f51d3516af)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
sphinx: remove DocBook files2020-10-06T12:56:17+00:00Nicolas Dechesnenicolas.dechesne@linaro.org2020-10-05T14:30:32+00:00urn:sha1:43d07a285181e64c30d98d10ff93ef50391efe59
The Yocto Project documentation was migrated to Sphinx. Let's remove
the deprecated DocBook files.
(From yocto-docs rev: 28fb0e63b2fbfd6426b00498bf2682bb53fdd862)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
docs: fix broken links2020-09-22T08:58:50+00:00Quentin Schulzfoss@0leil.net2020-09-17T21:09:47+00:00urn:sha1:d6ce950527981cf468f7091e5937333ad080e8b6
(From yocto-docs rev: 5139bf1d3ac7f31b711a8410a195ffc88ac560bf)
Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
sphinx: sdk-manual: Various URL, code block and other fixes to imported data2020-09-17T09:09:35+00:00Richard Purdierichard.purdie@linuxfoundation.org2020-09-14T12:34:34+00:00urn:sha1:de89b5a0b6ecb9a5b6a3e5a862cf4cee32dc8a94
(From yocto-docs rev: 12f5e9cb36409b813ffef9242ce9a042f08acf69)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
sphinx: insert blank below between title and toc2020-09-17T09:09:34+00:00Nicolas Dechesnenicolas.dechesne@linaro.org2020-09-01T12:19:20+00:00urn:sha1:721edcfd44a61c4ea7a88d4e46d35bbdbce99c56
Whenever a TOC follows a title/heading, a blank line is missing. So
let's add it explicitely.
(From yocto-docs rev: 600b6fe7837dd817d32350e1a45431bdcfe8ebbd)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
sphinx: manuals: Move boilerplate after toctree2020-09-17T09:09:34+00:00Richard Purdierichard.purdie@linuxfoundation.org2020-08-26T16:56:53+00:00urn:sha1:8f04fc58240fed4f17ef46302530320d0673379b
The boilerplate looks better after the ToC, still not quite
right but the boilerplate can be improved from here.
(From yocto-docs rev: 5e81b9c90f6f45acf26ba146e280bc2659ac14e5)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
sphinx: history: Move revision history to its own section2020-09-17T09:09:34+00:00Richard Purdierichard.purdie@linuxfoundation.org2020-08-26T16:51:05+00:00urn:sha1:83ebbf63e93048a8d4168eb174cbd35f873fb11d
The revision history tables look better in their own section,
move them.
(From yocto-docs rev: 27bf0f69b6dc04cea97a023ef52bec2b213d074f)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
sphinx: add links to section in the Bitbake manual2020-09-17T09:09:34+00:00Nicolas Dechesnenicolas.dechesne@linaro.org2020-07-31T15:58:42+00:00urn:sha1:f3e7db78adf417231ce29eb6a9a28a74857a2954
Use intersphinx extension to replace links to the Bitbake manual with
proper cross references.
(From yocto-docs rev: 458a6e540a2286ac838812d802306806f77b885c)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
sphinx: add links for Yocto project website2020-09-17T09:09:34+00:00Nicolas Dechesnenicolas.dechesne@linaro.org2020-07-30T09:00:01+00:00urn:sha1:283ed72d487ed78d4f8e0fcc17f635d6c212b7c6
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>