summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRichard Purdie <richard.purdie@linuxfoundation.org>2020-07-03 18:21:03 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2020-09-17 10:09:34 +0100
commit26c5622bb5551e1ad61db1c20890579dfb6b87c2 (patch)
tree17559fcf760594fe5d0d4c2a210a6dd144e79d68
parent6a9fd9bd72103a6ea1b0fe819630e252e8350cf7 (diff)
downloadpoky-26c5622bb5551e1ad61db1c20890579dfb6b87c2.tar.gz
sphinx: Organize top level docs
Clean up the top level docs index to refer to all the manuals with decent titles/links/layout and match the current website docs page links. (From yocto-docs rev: 45138057bf9446dfca7bf1ddef97104df57abe76) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/index.rst47
1 files changed, 36 insertions, 11 deletions
diff --git a/documentation/index.rst b/documentation/index.rst
index 1a96b6996e..e39b865b1d 100644
--- a/documentation/index.rst
+++ b/documentation/index.rst
@@ -10,16 +10,41 @@ Welcome to The Yocto Project's documentation!
10 10
11.. toctree:: 11.. toctree::
12 :maxdepth: 1 12 :maxdepth: 1
13 :caption: Introduction and Overview
14
15 Quick Build <brief-yoctoprojectqs/brief-yoctoprojectqs>
16 What I wish I'd known about Yocto Project <https://www.yoctoproject.org/docs/what-i-wish-id-known/>
17 Transitioning to a custom environment for systems development <https://www.yoctoproject.org/docs/transitioning-to-a-custom-environment>
18 Yocto Project Software Overview <https://www.yoctoproject.org/software-overview/>
19 Tips and Tricks Wiki <https://wiki.yoctoproject.org/wiki/TipsAndTricks>
20
21
22.. toctree::
23 :maxdepth: 1
24 :caption: Manuals
25
26 Overview and Concepts Manual <overview-manual/overview-manual>
27 Reference Manual <ref-manual/ref-manual>
28 Board Support Package (BSP) Developer's guide <bsp-guide/bsp-guide>
29 Development Tasks Manual <dev-manual/dev-manual>
30 Linux Kernel Development Manual <kernel-dev/kernel-dev>
31 Profile and Tracing Manual <profile-manual/profile-manual>
32 Application Development and the Extensible SDK (eSDK) <sdk-manual/sdk-manual>
33 Toaster Manual <toaster-manual/toaster-manual>
34 Test Environment Manual <test-manual/test-manual>
35 Bitbake User Manual <https://link to bitbake manual FIXME>
36
37.. toctree::
38 :maxdepth: 1
39 :caption: 'Mega' Manual
40
41 All-in-one 'Mega' Manual <https://www.yoctoproject.org/docs/@VER@/singleindex.html>
42
43.. toctree::
44 :maxdepth: 1
45 :caption: Manuals/Variable Index
13 46
14 brief-yoctoprojectqs/brief-yoctoprojectqs
15 overview-manual/overview-manual
16 bsp-guide/bsp-guide
17 ref-manual/ref-manual
18 dev-manual/dev-manual
19 adt-manual/adt-manual
20 kernel-dev/kernel-dev
21 profile-manual/profile-manual
22 sdk-manual/sdk-manual
23 toaster-manual/toaster-manual
24 test-manual/test-manual
25 genindex 47 genindex
48
49
50