mirror of
git://git.yoctoproject.org/poky.git
synced 2025-07-19 21:09:03 +02: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 <nicolas.dechesne@linaro.org> Tested-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
54 lines
1.5 KiB
ReStructuredText
54 lines
1.5 KiB
ReStructuredText
.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
|
|
|
|
.. The Yocto Project documentation master file, created by
|
|
sphinx-quickstart on Mon Apr 13 09:38:33 2020.
|
|
You can adapt this file completely to your liking, but it should at least
|
|
contain the root `toctree` directive.
|
|
|
|
Welcome to the Yocto Project Documentation
|
|
==========================================
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Introduction and Overview
|
|
|
|
Quick Build <brief-yoctoprojectqs/index>
|
|
what-i-wish-id-known
|
|
transitioning-to-a-custom-environment
|
|
Yocto Project Software Overview <https://www.yoctoproject.org/software-overview/>
|
|
Tips and Tricks Wiki <https://wiki.yoctoproject.org/wiki/TipsAndTricks>
|
|
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Manuals
|
|
|
|
Overview and Concepts Manual <overview-manual/index>
|
|
Reference Manual <ref-manual/index>
|
|
Board Support Package (BSP) Developer's guide <bsp-guide/index>
|
|
Development Tasks Manual <dev-manual/index>
|
|
Linux Kernel Development Manual <kernel-dev/index>
|
|
Profile and Tracing Manual <profile-manual/index>
|
|
Application Development and the Extensible SDK (eSDK) <sdk-manual/index>
|
|
Toaster Manual <toaster-manual/index>
|
|
Test Environment Manual <test-manual/index>
|
|
bitbake
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: 'Mega' Manual
|
|
|
|
All-in-one 'Mega' Manual <https://docs.yoctoproject.org/singleindex.html>
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Manuals/Variable Index
|
|
|
|
genindex
|
|
Current/Previous Version Specific Manuals <releases>
|
|
|
|
|
|
|