aboutsummaryrefslogtreecommitdiff
path: root/docs/index.rst.in
blob: e2151a468a1ffe6b318c27cd42bfffdb202735d0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
:Page authors: Gyorgy Szing <gyorgy.szing@arm.com>

..
   The build-system will copy all documents into a temporary directory tree
   before the documentation is built.
   This file will be copied to the top level and thus please use relative paths
   as if this file would be in <TFM_ROOT_DIR>.
   
   The values between @ characters will be filled in by CMake.


Welcome to TF-M's documentation!
================================

.. toctree::
    :maxdepth: 2
    :glob:
    :hidden:

    contributing
    docs/dco
    glossary
    maintainers
    docs/user_guides/tfm_sw_requirement
    docs/user_guides/tfm_build_instruction
    docs/coding_guide
    docs/user_guides/tfm_user_guide
    docs/user_guides/os_migration_guide_armv8m
    docs/user_guides/tfm_integration_guide
    docs/user_guides/tfm_ns_client_identification
    docs/user_guides/tfm_secure_boot

.. toctree::
    :maxdepth: 2
    :caption: Processes
    :glob:
    :hidden:

    docs/processes/**

.. toctree::
    :maxdepth: 2
    :caption: Secure services
    :glob:
    :hidden:

    docs/user_guides/services/*

.. toctree::
    :maxdepth: 2
    :caption: Components
    :glob:
    :hidden:

    lib/**

.. toctree::
    :maxdepth: 2
    :caption: Target platforms
    :glob:
    :hidden:

    platform/**

.. toctree::
    :caption: Design documents
    :maxdepth: 2
    :glob:
    :hidden:

    @ACCEPTED_DD_LIST@

.. toctree::
    :caption: Draft design documents
    :maxdepth: 2
    :glob:
    :hidden:

    @DRAFT_DD_LIST@

.. toctree::
    :caption: Rejected design documents
    :maxdepth: 2
    :glob:
    :hidden:

    @REJECTED_DD_LIST@

.. include:: readme.rst

-----------

*Copyright (c) 2019, Arm Limited. All rights reserved.*