linux/poky.git/documentation/index.rst, branch honister-3.4.4

ref-manual: move migration guides to separate document

2021-06-14T21:45:33+00:00

This makes the reference manual much lighter by moving the migration guides to a separate document. The migration guides are also reordered from last to first, and they appear directly in the left bar, making them easier to find in the documentation. (From yocto-docs rev: 5121b86ee97eb62a0c69c9ad1fc0e3fabbe3e934) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

index: split releases manuals and indexes into two sections in the tree

2021-06-02T22:32:34+00:00

(From yocto-docs rev: f245b7b096f699cdc4426022d61d963d7deb9a92) Signed-off-by: Nicolas Dechesne Reviewed-by: Quentin Schulz Tested-by: Michael Opdenacker Signed-off-by: Richard Purdie

index: remove links to releases manual and index

2021-06-02T22:32:34+00:00

Keep the links in the left side navigation bar, but remove them from the main page. (From yocto-docs rev: d01324cfb6ecada22005ca05db99b0c1f75eb22e) Signed-off-by: Nicolas Dechesne Reviewed-by: Quentin Schulz Tested-by: Michael Opdenacker Signed-off-by: Richard Purdie

index: remove the link/section to 'mega manual' from main page

2021-06-02T22:32:34+00:00

The 'megamanuel' can be selected using the drop down menu on the documentation website. It was reported it is confusing to have it on the main page (and in the left side bar) as well. Let's remove it. (From yocto-docs rev: 593898dc4a4695395856ea481b58cc5092ed3263) Signed-off-by: Nicolas Dechesne Reviewed-by: Quentin Schulz Tested-by: Michael Opdenacker Signed-off-by: Richard Purdie

docs: add a top level page for bitbake documentation

2021-04-09T14:24:46+00:00

The top level index file includes a link to the Bitbake documentation. This link is static, however the location of the Bitbake documentation depends on the intersphinx configuration. As such, when looking at an old YP docs release, the link to the bitbake documentation is always the same (and wrong). Since we cannot use a cross reference in a toc index, this patch creates an intermediate page for bitbake documentation, and in that page we insert the right link to the bibtake documentation (e.g. :doc:`bitbake:index`) which will be adjusted dynamically based on intersphinx config. (From yocto-docs rev: 4f7f451df266a307b34bf145b29291ca85eb882f) Signed-off-by: Nicolas Dechesne Tested-by: Michael Opdenacker Signed-off-by: Richard Purdie

sphinx: rename top level document in each manual

2020-12-09T12:21:27+00:00

It is more common to call the top level document index.rst. This is what this patch is doing, along with all required references fixup. (From yocto-docs rev: 2cea7fbba9210479fc0387d7e1b80da9885558f0) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie

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

2020-10-08T10:28:30+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: 8d30c3d792755a7bfdb74b331dad98f51d3516af) Signed-off-by: Richard Purdie

sphinx: fix up some trademark and branding issues

2020-10-01T20:29:31+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: 6bae1372218e0b10258e4fa6fef72fc1708a329c) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie

sphinx: index.rst: Fix links

2020-09-17T09:09:35+00:00

Correct the bitbake and megamanual URLs. (From yocto-docs rev: 9da83688584f891d9a1fa363bbf073ab7ba0aad7) Signed-off-by: Richard Purdie

sphinx: convert 'transitioning to a custom environment'

2020-09-17T09:09:34+00:00

This page is currently a static web page in the Yocto project website, in the docs section. While we are converting the whole YP docs into its own website, let's convert this file as well. (From yocto-docs rev: 0985ac0570c63e5ac8c4329155ed77f71f56f069) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie