mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-05-30 00:20:08 +00:00
Code Issues Projects Releases Wiki Activity

docs: add a top level page for bitbake documentation

Browse Source 
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 <nicolas.dechesne@linaro.org>
Tested-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Nicolas Dechesne
2021-04-07 18:35:06 +02:00
committed by Richard Purdie
parent c380ba5a17
commit ddc9e2fd33
2 changed files with 20 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
documentation/index.rst
+1 -1
View File
@@ -34,7 +34,7 @@ Welcome to the Yocto Project Documentation
Application Development and the Extensible SDK (eSDK) <sdk-manual/index>
Toaster Manual <toaster-manual/index>
Test Environment Manual <test-manual/index>
Bitbake User Manual <https://docs.yoctoproject.org/bitbake>
bitbake
.. toctree::
:maxdepth: 1