mirror of
https://git.yoctoproject.org/poky
synced 2026-09-20 12:49:33 +02:00
b39088793e
The homepage of the Yocto Project documentation currently has no introduction and only displays the table of contents. Inspired by https://docs.kernel.org, provide a short introduction to the documentation and also precede each section with a short sentence about what the section contains. The section titles are voluntarily duplicated in the document itself and in the toctree directive, so that the sidebar still contains them, and we can have text between the section titles and the toctree content. However this also duplicates the title in the document itself, so add CSS directive in our customization file to hide the duplicates. Note that these titles do not show in the PDF and ePub outputs as those are generated differently. (From yocto-docs rev: 378360de3dab9b6f349bac852eff645ab0066093) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 976ee1e250af67b944521b0446c255c88e57db07) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Paul Barker <paul@pbarker.dev>
87 lines
2.4 KiB
ReStructuredText
87 lines
2.4 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
|
|
==========================================
|
|
|
|
This is the top level of the Yocto Project documentation tree. The Yocto Project
|
|
documentation is always a work in progress, just like the Yocto Project itself.
|
|
Improvements to the documentation are always welcome; join the
|
|
:yocto_lists:`docs mailing list </g/docs>` if you want to help out.
|
|
|
|
Introduction and Overview
|
|
=========================
|
|
|
|
Get started using the Yocto Project.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Introduction and Overview
|
|
|
|
Quick Build <brief-yoctoprojectqs/index>
|
|
what-i-wish-id-known
|
|
transitioning-to-a-custom-environment
|
|
Yocto Project Technical Overview <https://www.yoctoproject.org/development/technical-overview/>
|
|
Tips and Tricks Wiki <https://wiki.yoctoproject.org/wiki/TipsAndTricks>
|
|
|
|
Manuals
|
|
=======
|
|
|
|
A collection of manuals covering many aspects of the Yocto Project, including
|
|
reference definitions, tutorials, and details about the project's
|
|
infrastructure.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Manuals
|
|
|
|
Overview and Concepts Manual <overview-manual/index>
|
|
Contributor Guide <contributor-guide/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
|
|
|
|
Security Reference
|
|
==================
|
|
|
|
Security-related processes and contact information for vulnerability reporting.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Security Reference
|
|
|
|
Yocto Project Security Reference <security-reference/index>
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Release Manuals
|
|
:hidden:
|
|
|
|
Release Information <migration-guides/index>
|
|
releases
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Documentation Index
|
|
:hidden:
|
|
|
|
genindex
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Documentation Downloads
|
|
:hidden:
|
|
|
|
downloads
|