linux/poky.git/documentation, branch dunfell-23.0.6

documentation: prepare for 3.1.6 release

2021-02-17T17:35:40+00:00

Bump the current version to 3.1.6 (From yocto-docs rev: 660684b1a1ece4bdedfd63b9fc65d14f05c226d5) Signed-off-by: Steve Sakoman Signed-off-by: Richard Purdie

documentation: prepare for 3.1.5 release

2021-01-13T08:57:57+00:00

Bump the current version to 3.1.5 (From yocto-docs rev: b367b2ece436cdd86f8408fbec1b263e03ed4267) Signed-off-by: Steve Sakoman Signed-off-by: Richard Purdie

sphinx: update link to bitbake docs

2021-01-04T11:23:14+00:00

The Sphinx based Bitbake documentation for dunfell release is published to https://docs.yoctoproject.org/bitbake/1.46/. (From yocto-docs rev: b8a0f97563d9680786228ecd11fafb8a4c09ea0a) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie

conf.py: set version to 3.1.4

2021-01-04T10:55:02+00:00

(From yocto-docs rev: 488a421fea826a2cff27dd009768430769f25ab0) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie

Makefile: enable parallel build

2021-01-04T10:55:02+00:00

>From sphinx-build man page: -j N build in parallel with N processes where possible (special value "auto" will set N to cpu-count) (From yocto-docs rev: f83b7921f99a1e1f448c2694184dd72e8f09c2d2) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie (cherry picked from commit 1847aeea8b88c84f821610803264955e51e31d2f) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie

conf.py: Improve TOC and Outline depth in PDF output

2021-01-04T10:55:02+00:00

The default PDF output shows only chapter headings in the table of contents and in the outline (aka PDF bookmarks). We should override these defaults to set something more suitable. With a depth of 2 for the TOC we see both section and subsection headings which is enough to get the list of classes in the reference manual and the list of topics under "Common Tasks" in the development manual. Going to a deeper level would make the TOC unwieldy but we do want to make sure we can navigate more precisely using the outline (commonly shown in a left tab in PDF viewers) so we set the depth to 5 for the outline. (From yocto-docs rev: f74238d08163f6fc45939422ae96a3d69c0e4449) Signed-off-by: Paul Barker Signed-off-by: Richard Purdie (cherry picked from commit 5db16d3b01da0a138b6413347fcf2321a1bfae08) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie

poky.yaml: remove unused variables

2021-01-04T10:55:02+00:00

There are plenty of variables in poky.yaml which are not used anywhere in the docs. So let's remove them. We can always add the one we need later. Note ORGEMAIL could be used in boilerplate.rst, however this file is not parsed but included, and somehow the yocto-vars.py exenstion does not process this file, so we cannot use a variable there. (From yocto-docs rev: 4c72a3b1a8e7b0d3164ef23cf47898834837b9d3) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie (cherry picked from commit f1164d2e6401d93e0b4e484b090abbe0f72a6ac7) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie

documentation: Add Pipenv support

2021-01-04T10:55:02+00:00

Adds a Pipfile so that Pipenv can be used to automatically install all the dependencies required to build the documentation (From yocto-docs rev: 5fc0a3011c47388d9c6447c3be00fefcbaf00f5c) Signed-off-by: Joshua Watt Signed-off-by: Richard Purdie (cherry picked from commit 31658ad30827d38dcd4ea83bcfb828441c7c3eca) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie

adt-manual: delete obsolete ADT manual, and related content

2021-01-04T10:55:02+00:00

Since the ADT manual has long been superseded by the SDK manual, remove the entire adt-manual directory, and the references to it in the two top-level files "conf.py" and "poky.yaml". (From yocto-docs rev: bdf601bfa07e05e3f834581d87105d0ebb4034d0) Signed-off-by: Robert P. J. Day Signed-off-by: Nicolas Dechesne (cherry picked from commit 64b2e83bddf6af0439ac7089ac95e60faa696cfc) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie

README: "yocto-project-qs" -> "brief-yoctoprojectqs"

2021-01-04T10:55:02+00:00

Directory has been renamed, so fix README and add a bit more white space to keep everything lined up. (From yocto-docs rev: 98da73f772f5ad8edb47f7c6d1e1c55133d51fdd) Signed-off-by: Robert P. J. Day Signed-off-by: Richard Purdie (cherry picked from commit cdd4c705f7271e31e44a94c79b050eda1fba5945) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie