Files
poky/documentation/index.rst
Nicolas Dechesne fa0cb4d34b sphinx: import docs
The Yocto Project docs was migrated from Docbook to Sphinx in YP
 3.2. This 3.1 is an LTS release, and since 3.1 docs are 'close to'
 the docs in 3.2, we agreed to backport sphinx docs onto 3.1.

This first patch brings all changes done in 3.2 until:
7f64574f7 README: include detailed information about sphinx

There are other changes after this commit, but they will be
 selectively backported in individual patches.

This patch was generated with the following command:

git cherry-pick -n \
 $(git log --reverse --oneline \
 ac352ad7f95db7eeacb53c2778caa31800bd7c26..7f64574f7 \
| cut -f1 -d' ')

The following commits were applies in the dunfell docs, but not in
master, so they were first reverted (and squashed into this change). A
commit will reintroduce the content from these patches in the Sphinx
files in a followup patch.

069c27574 Documenation: Prepared for the 3.1.1 release
bd140f0f9 Documentation: Add 3.1.1 version updates missing from previous commit
17cc71a8f Documenation: Prepared for the 3.1.2 release
1a69e2c02 Documenation: Prepared for the 3.1.3 release
8910ac1c7 Documenation: Prepared for the 3.1.4 release

(From yocto-docs rev: c25fe058b88b893b0d146f3ed27320b47cdec236)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-04 10:55:00 +00:00

54 lines
1.6 KiB
ReStructuredText

.. SPDX-License-Identifier: CC-BY-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's documentation!
=============================================
|
.. toctree::
:maxdepth: 1
:caption: Introduction and Overview
Quick Build <brief-yoctoprojectqs/brief-yoctoprojectqs>
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/overview-manual>
Reference Manual <ref-manual/ref-manual>
Board Support Package (BSP) Developer's guide <bsp-guide/bsp-guide>
Development Tasks Manual <dev-manual/dev-manual>
Linux Kernel Development Manual <kernel-dev/kernel-dev>
Profile and Tracing Manual <profile-manual/profile-manual>
Application Development and the Extensible SDK (eSDK) <sdk-manual/sdk-manual>
Toaster Manual <toaster-manual/toaster-manual>
Test Environment Manual <test-manual/test-manual>
Bitbake User Manual <https://docs.yoctoproject.org/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>