TrustedFirmware Git Browser
Code Review Sign In
review.trustedfirmware.org / next / TF-M / trusted-firmware-m / db9783ceb84ae0c99205bc0a8bb3214b2c3a2089 / . / docs / index.rst
blob: f9c12829796336755158ddaa3d8f3485da2fa6c4 [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.
6 This fill will be copied to the top level and thus please use relative paths
7 as if this file would be in <TFM_ROOT_DIR>.
8
9Welcome to TF-M's documentation!
10================================
11
12.. toctree::
13 :maxdepth: 2
14 :glob:
15 :hidden:
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame^]16
17 contributing
18 docs/dco
19 glossary
20 maintainers
21 docs/user_guides/tfm_sw_requirement
22 docs/user_guides/tfm_build_instruction
23 docs/coding_guide
24 docs/user_guides/tfm_user_guide
25 docs/user_guides/os_migration_guide_armv8m
26 docs/user_guides/tfm_integration_guide
27 docs/user_guides/tfm_ns_client_identification
28 docs/user_guides/tfm_secure_boot
29
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]30.. toctree::
31 :maxdepth: 2
32 :caption: Secure services
33 :glob:
34 :hidden:
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame^]35
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]36 docs/user_guides/services/*
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame^]37
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]38.. toctree::
39 :maxdepth: 2
40 :caption: Components
41 :glob:
42 :hidden:
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame^]43
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]44 lib/**
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame^]45
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]46.. toctree::
47 :maxdepth: 2
48 :caption: Target platforms
49 :glob:
50 :hidden:
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame^]51
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]52 platform/**
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame^]53
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]54.. toctree::
55 :caption: Design documents
56 :maxdepth: 2
57 :glob:
58 :hidden:
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame^]59
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]60 docs/design_documents/*
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame^]61
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]62.. toctree::
63 :caption: Draft design documents
64 :maxdepth: 2
65 :glob:
66 :hidden:
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame^]67
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]68 docs/design_documents/drafts/*
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame^]69
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]70.. toctree::
71 :caption: Rejected design documents
72 :maxdepth: 2
73 :glob:
74 :hidden:
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame^]75
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]76 docs/design_documents/rejected/*
77
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame^]78.. include:: readme.rst
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]79
80-----------
81
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame^]82*Copyright (c) 2019, Arm Limited. All rights reserved.*