TrustedFirmware Git Browser
Code Review Sign In
review.trustedfirmware.org / next / TF-M / trusted-firmware-m / 80efacd2d8b8030f0449580229761a30db428f71 / . / docs / index.rst.in
blob: 8142efa1c2c49293b626287858070f0ccf823553 [file] [log] [blame]
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]1:Page authors: Gyorgy Szing <gyorgy.szing@arm.com>
2
3..
4 The build-system will copy all documents into a temporary directory tree
5 before the documentation is built.
Gyorgy Szing5c873232019-05-10 23:28:14 +0200[diff] [blame]6 This file will be copied to the top level and thus please use relative paths
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]7 as if this file would be in <TFM_ROOT_DIR>.
Gyorgy Szing5c873232019-05-10 23:28:14 +0200[diff] [blame]8
9 The values between @ characters will be filled in by CMake.
10
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]11
12Welcome to TF-M's documentation!
13================================
14
15.. toctree::
16 :maxdepth: 2
17 :glob:
18 :hidden:
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame]19
20 contributing
21 docs/dco
22 glossary
23 maintainers
Galanakis, Minos80efacd2019-07-03 15:20:20 +0100[diff] [blame^]24 docs/lic
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame]25 docs/user_guides/tfm_sw_requirement
26 docs/user_guides/tfm_build_instruction
27 docs/coding_guide
28 docs/user_guides/tfm_user_guide
29 docs/user_guides/os_migration_guide_armv8m
30 docs/user_guides/tfm_integration_guide
31 docs/user_guides/tfm_ns_client_identification
32 docs/user_guides/tfm_secure_boot
33
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]34.. toctree::
35 :maxdepth: 2
Gyorgy Szing5c873232019-05-10 23:28:14 +0200[diff] [blame]36 :caption: Processes
37 :glob:
38 :hidden:
39
40 docs/processes/**
41
42.. toctree::
43 :maxdepth: 2
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]44 :caption: Secure services
45 :glob:
46 :hidden:
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame]47
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]48 docs/user_guides/services/*
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame]49
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]50.. toctree::
51 :maxdepth: 2
52 :caption: Components
53 :glob:
54 :hidden:
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame]55
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]56 lib/**
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame]57
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]58.. toctree::
59 :maxdepth: 2
60 :caption: Target platforms
61 :glob:
62 :hidden:
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame]63
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]64 platform/**
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame]65
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]66.. toctree::
67 :caption: Design documents
68 :maxdepth: 2
69 :glob:
70 :hidden:
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame]71
Gyorgy Szing5c873232019-05-10 23:28:14 +0200[diff] [blame]72 @ACCEPTED_DD_LIST@
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame]73
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]74.. toctree::
75 :caption: Draft design documents
76 :maxdepth: 2
77 :glob:
78 :hidden:
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame]79
Gyorgy Szing5c873232019-05-10 23:28:14 +0200[diff] [blame]80 @DRAFT_DD_LIST@
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame]81
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]82.. toctree::
83 :caption: Rejected design documents
84 :maxdepth: 2
85 :glob:
86 :hidden:
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame]87
Gyorgy Szing5c873232019-05-10 23:28:14 +0200[diff] [blame]88 @REJECTED_DD_LIST@
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]89
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame]90.. include:: readme.rst
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]91
92-----------
93
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame]94*Copyright (c) 2019, Arm Limited. All rights reserved.*