mirror of
https://git.yoctoproject.org/poky
synced 2026-09-17 21:49:32 +02:00
779318a316
The current non-HTML-based documents we support is the PDF format. For this format, this intro paragraph is placed right after the table of contents, which is odd and breaks the flow of the document. Show this paragraph only in HTML-based document, which includes the HTML and ePUB formats. Link: https://patch.msgid.link/20260818-intros-only-in-html-v1-1-4fe4c54655bf@bootlin.com (From yocto-docs rev: f24fed24c0893074d5990b15436229d9957d4038) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 8e70193dc4c6271e0226cdda7110cf60347f0f51) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Paul Barker <paul@pbarker.dev>
118 lines
3.0 KiB
ReStructuredText
118 lines
3.0 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
|
|
==========================================
|
|
|
|
.. only:: html
|
|
|
|
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
|
|
|
|
Get familiar with the development environment and concepts of the Yocto Project.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
Overview and Concepts <overview-manual/index>
|
|
|
|
Additional introductory resources.
|
|
|
|
- `Technical Overview (external website) <https://www.yoctoproject.org/development/technical-overview/>`__
|
|
- `Tips and Tricks Wiki (external website) <https://wiki.yoctoproject.org/wiki/TipsAndTricks>`__
|
|
|
|
Contributing to the Yocto Project
|
|
=================================
|
|
|
|
Guides on how to contribute to the different parts of the Yocto Project.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Contributor Guide
|
|
|
|
Contributor Guide <contributor-guide/index>
|
|
|
|
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
|
|
|
|
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 User Manual <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>
|
|
|
|
Release Information
|
|
===================
|
|
|
|
Release notes and migration guides for the different Yocto Project releases.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Release Information
|
|
|
|
Release Notes and Migration Guides <migration-guides/index>
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Release Manuals
|
|
:hidden:
|
|
|
|
releases
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Documentation Index
|
|
:hidden:
|
|
|
|
genindex
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Documentation Downloads
|
|
:hidden:
|
|
|
|
downloads
|