linux/poky.git/documentation/index.rst, branch walnascar-5.2.4

doc: add a download page for epub and pdf

2024-11-12T11:09:51+00:00

These files are placed in the _static directory during publish. Note that Sphinx does not complain if files do not exist during compilation (since they are copied at the end). This is why this was used instead of the ":download:" role. (From yocto-docs rev: 3b9287eb5cde22cf5be48734d63efbd30c66ef06) Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

contributor-guide: move to 2nd place in top menu

2023-08-30T14:54:59+00:00

To give it more visibility (From yocto-docs rev: f5770f554d01c3f53058425ecb16c642e36c6806) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

manuals: create a dedicated "Contributor Guide" document

2023-08-30T14:54:59+00:00

Starting from the original contents of dev-manual/changes.rst and from text contributed by Richard Purdie. (From yocto-docs rev: 55587d9dd009cbc92273376e0f7665b2d574d280) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

manuals: add 3.4 and 3.4.1 release notes after migration information

2022-02-18T17:58:02+00:00

Only done for release 3.4 and 3.4.1 so far. Release notes are kept under the migration-guides/ directory for the moment, for easier reviewing. (From yocto-docs rev: b311070d866cf4ab51c72ff3ac7bc41ea3e932cb) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

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