summaryrefslogtreecommitdiffstats
path: root/documentation/index.rst
diff options
context:
space:
mode:
authorNicolas Dechesne <nicolas.dechesne@linaro.org>2020-11-20 20:17:33 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2021-01-04 10:55:00 +0000
commitfa0cb4d34b1073f215fa3c680f2316208739d53d (patch)
treeba89c1f4289fd6456af4409a6a19caf6548dfb9c /documentation/index.rst
parenta038e58f3cd82c56102444bdc5ac76c9f1550a0d (diff)
downloadpoky-fa0cb4d34b1073f215fa3c680f2316208739d53d.tar.gz
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>
Diffstat (limited to 'documentation/index.rst')
-rw-r--r--documentation/index.rst53
1 files changed, 53 insertions, 0 deletions
diff --git a/documentation/index.rst b/documentation/index.rst
new file mode 100644
index 0000000000..258ecb81a7
--- /dev/null
+++ b/documentation/index.rst
@@ -0,0 +1,53 @@
1.. SPDX-License-Identifier: CC-BY-2.0-UK
2
3.. The Yocto Project documentation master file, created by
4 sphinx-quickstart on Mon Apr 13 09:38:33 2020.
5 You can adapt this file completely to your liking, but it should at least
6 contain the root `toctree` directive.
7
8Welcome to The Yocto Project's documentation!
9=============================================
10
11|
12
13.. toctree::
14 :maxdepth: 1
15 :caption: Introduction and Overview
16
17 Quick Build <brief-yoctoprojectqs/brief-yoctoprojectqs>
18 what-i-wish-id-known
19 transitioning-to-a-custom-environment
20 Yocto Project Software Overview <https://www.yoctoproject.org/software-overview/>
21 Tips and Tricks Wiki <https://wiki.yoctoproject.org/wiki/TipsAndTricks>
22
23
24.. toctree::
25 :maxdepth: 1
26 :caption: Manuals
27
28 Overview and Concepts Manual <overview-manual/overview-manual>
29 Reference Manual <ref-manual/ref-manual>
30 Board Support Package (BSP) Developer's guide <bsp-guide/bsp-guide>
31 Development Tasks Manual <dev-manual/dev-manual>
32 Linux Kernel Development Manual <kernel-dev/kernel-dev>
33 Profile and Tracing Manual <profile-manual/profile-manual>
34 Application Development and the Extensible SDK (eSDK) <sdk-manual/sdk-manual>
35 Toaster Manual <toaster-manual/toaster-manual>
36 Test Environment Manual <test-manual/test-manual>
37 Bitbake User Manual <https://docs.yoctoproject.org/bitbake>
38
39.. toctree::
40 :maxdepth: 1
41 :caption: 'Mega' Manual
42
43 All-in-one 'Mega' Manual <https://docs.yoctoproject.org/singleindex.html>
44
45.. toctree::
46 :maxdepth: 1
47 :caption: Manuals/Variable Index
48
49 genindex
50 Current/Previous Version Specific Manuals <releases>
51
52
53