TrustedFirmware Git Browser
Code Review Sign In
review.trustedfirmware.org / next / TF-M / trusted-firmware-m / 5c87323db941c3470eb4d4998981ced8b33cf84c / . / docs / index.rst.in
blob: e2151a468a1ffe6b318c27cd42bfffdb202735d0 [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
24 docs/user_guides/tfm_sw_requirement
25 docs/user_guides/tfm_build_instruction
26 docs/coding_guide
27 docs/user_guides/tfm_user_guide
28 docs/user_guides/os_migration_guide_armv8m
29 docs/user_guides/tfm_integration_guide
30 docs/user_guides/tfm_ns_client_identification
31 docs/user_guides/tfm_secure_boot
32
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]33.. toctree::
34 :maxdepth: 2
Gyorgy Szing5c873232019-05-10 23:28:14 +0200[diff] [blame^]35 :caption: Processes
36 :glob:
37 :hidden:
38
39 docs/processes/**
40
41.. toctree::
42 :maxdepth: 2
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]43 :caption: Secure services
44 :glob:
45 :hidden:
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame]46
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]47 docs/user_guides/services/*
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame]48
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]49.. toctree::
50 :maxdepth: 2
51 :caption: Components
52 :glob:
53 :hidden:
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame]54
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]55 lib/**
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame]56
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]57.. toctree::
58 :maxdepth: 2
59 :caption: Target platforms
60 :glob:
61 :hidden:
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame]62
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]63 platform/**
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame]64
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]65.. toctree::
66 :caption: Design documents
67 :maxdepth: 2
68 :glob:
69 :hidden:
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame]70
Gyorgy Szing5c873232019-05-10 23:28:14 +0200[diff] [blame^]71 @ACCEPTED_DD_LIST@
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame]72
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]73.. toctree::
74 :caption: Draft design documents
75 :maxdepth: 2
76 :glob:
77 :hidden:
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame]78
Gyorgy Szing5c873232019-05-10 23:28:14 +0200[diff] [blame^]79 @DRAFT_DD_LIST@
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame]80
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]81.. toctree::
82 :caption: Rejected design documents
83 :maxdepth: 2
84 :glob:
85 :hidden:
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame]86
Gyorgy Szing5c873232019-05-10 23:28:14 +0200[diff] [blame^]87 @REJECTED_DD_LIST@
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]88
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame]89.. include:: readme.rst
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]90
91-----------
92
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame]93*Copyright (c) 2019, Arm Limited. All rights reserved.*