linux/poky.git/documentation/index.rst, branch hardknott-3.3

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

sphinx: convert 'what I wish I'd known'

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: 1d4db1f776cdb775f79cd5e2089da01e0d9c43ea) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie

sphinx: Add support for multiple docs version

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

Enhance the sphinx experience/nagivation with: * Remove the pointless looking parts of breadcrumb navigtation * Add a document type switcher to the breadcrumb navigation * Add a version selection switch to the breadcrumb navigation (From yocto-docs rev: 1823624bdb9ea002d44c9e6d0fd4cd662bff36ad) Signed-off-by: Richard Purdie

sphinx: insert blank below between title and toc

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

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 Signed-off-by: Richard Purdie

sphinx: releases.rst: Add index/links to docs for previous releases

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

(From yocto-docs rev: 627f06d19909eff246b08e889068fd1ecddd569b) Signed-off-by: Richard Purdie Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie

sphinx: Organize top level docs

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

Clean up the top level docs index to refer to all the manuals with decent titles/links/layout and match the current website docs page links. (From yocto-docs rev: 45138057bf9446dfca7bf1ddef97104df57abe76) Signed-off-by: Richard Purdie