linux/poky.git/documentation/conf.py, branch yocto-3.1.7

documentation: prepare for 3.1.7 release

2021-04-13T13:11:52+00:00

(From yocto-docs rev: 5a54200a8702e473ecbbc3dbbdaa24169796c9e8) Signed-off-by: Steve Sakoman Signed-off-by: Richard Purdie

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

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

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

docs: Fix license CC-BY-2.0-UK -> CC-BY-SA-2.0-UK

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

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: ac9eede80f19c6e2138406209ab5700e89a244a0) Signed-off-by: Richard Purdie (cherry picked from commit 8d30c3d792755a7bfdb74b331dad98f51d3516af) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie

sphinx: fix up some trademark and branding issues

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

The following changes were required after a review of trademark and branding guidelines: 1. add (R) to 'Yocto Project' on the top left (above the logo) 2. Fix up the capitalization of the main page title 3. Add the copyright/legal blurb at the bottom of the page For 3. it turned out to be simpler to override the whole footer.html template, and maintain our own version. Also I took the liberty to remove the 'next' and 'previous' buttons since I believe they are not especially useful, given the navigation bar on the left side. Reported-by: Tracey Erway (From yocto-docs rev: a29ee99f81aa5b3cc66493e79712a3b5dc31e23f) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie (cherry picked from commit 6bae1372218e0b10258e4fa6fef72fc1708a329c) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie

sphinx: import docs

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

The Yocto Project docs was migrated from Docbook to Sphinx in YP 3.2. This 3.1 is an LTS release, and since 3.1 docs are 'close to' the docs in 3.2, we agreed to backport sphinx docs onto 3.1. This first patch brings all changes done in 3.2 until: 7f64574f7 README: include detailed information about sphinx There are other changes after this commit, but they will be selectively backported in individual patches. This patch was generated with the following command: git cherry-pick -n \ $(git log --reverse --oneline \ ac352ad7f95db7eeacb53c2778caa31800bd7c26..7f64574f7 \ | cut -f1 -d' ') The following commits were applies in the dunfell docs, but not in master, so they were first reverted (and squashed into this change). A commit will reintroduce the content from these patches in the Sphinx files in a followup patch. 069c27574 Documenation: Prepared for the 3.1.1 release bd140f0f9 Documentation: Add 3.1.1 version updates missing from previous commit 17cc71a8f Documenation: Prepared for the 3.1.2 release 1a69e2c02 Documenation: Prepared for the 3.1.3 release 8910ac1c7 Documenation: Prepared for the 3.1.4 release (From yocto-docs rev: c25fe058b88b893b0d146f3ed27320b47cdec236) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie