Commit Graph

10 Commits

Author SHA1 Message Date
Michael Opdenacker
8b812b29c4 manuals: add missing SPDX license header to source files
(From yocto-docs rev: 86737cc4583f1ef43bda10033c801329ba0c8b81)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-12-18 10:41:21 +00:00
Michael Opdenacker
4def515eeb manuals: replace "_" by "__" in external links
(From yocto-docs rev: 25142cd8121fdd6a8e0524fc8417fc666c498981)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-28 15:48:03 +01:00
Michael Opdenacker
138219ce3b manuals: replace Freenode by Libera Chat as IRC host
Fixes [YOCTO #14546]
This also replaces the "#poky" channel (inactive)
by "#oe", which is more actively used.

(From yocto-docs rev: 46f98fe4f502aac8b16ba785490e9cf46364e4ec)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-09-18 13:03:45 +01:00
Michael Opdenacker
c643a4749c manuals: Spellcheck and capitalization fixes
- Spelling fixes found using Emacs' spelling checker
  configured for US English
- Fixes for some capitalization issues, especially some
  project names (QEMU, openSUSE, BusyBox), that were not
  consistently used with the same capitalization anyway.
- A few whitespace fixes too

(From yocto-docs rev: 05d69f17490dcc4933dcd85e57d9db53b912084a)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-06 22:29:49 +01:00
Paul Barker
3b298e6ddd documentation: Use https links where possible
(From yocto-docs rev: cd4c5e9928866f910ac97cf3e0612e6245da30bd)

Signed-off-by: Paul Barker <pbarker@konsulko.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-24 08:23:33 +00:00
Richard Purdie
8f04fc5824 sphinx: manuals: Move boilerplate after toctree
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>
2020-09-17 10:09:34 +01:00
Richard Purdie
fda08f30b1 sphinx: boilerplate.rst: Sphinx puts the copyright elsewhere
Its elsewhere so drop from boilerplate.

(From yocto-docs rev: b974d1193480e6b005e3e66ab809afdda6a89897)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:34 +01:00
Richard Purdie
27e80a5e00 sphinx: boilerplate.rst: Drop versions notes as we have better navigation now
Now we have better navigation with sphinx, and alert text about old
versions, we can drop the top two bullts. The remaining bits can just
become text.

(From yocto-docs rev: bb963c8c906644148182a1fc441c676f13cdf6ce)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:34 +01:00
Nicolas Dechesne
283ed72d48 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>
2020-09-17 10:09:34 +01:00
Nicolas Dechesne
54d38a91e1 sphinx: add boilerplate file
A certain amount of boilerplate is added at the beginning of all
documents. In DocBook this is copy/pasted in each file. Let's create a
boilerplate ReST file, which we will include in each document,
wherever it's required.

(From yocto-docs rev: 37e0d5f246c614e62a7c0d4d72a5d6ce9ec5325e)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:33 +01:00