| Gyorgy Szing | 74dae3c | 2018-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 | |
| 9 | Welcome to TF-M's documentation! |
| 10 | ================================ |
| 11 | |
| 12 | .. toctree:: |
| 13 | :maxdepth: 2 |
| 14 | :glob: |
| 15 | :hidden: |
| 16 | |
| 17 | contributing.md |
| 18 | glossary.md |
| 19 | maintainers.md |
| 20 | docs/user_guides/tfm_sw_requirement.md |
| 21 | docs/user_guides/tfm_build_instruction.md |
| 22 | docs/coding_guide.md |
| 23 | docs/user_guides/tfm_user_guide.md |
| 24 | docs/user_guides/os_migration_guide_armv8m.md |
| 25 | docs/user_guides/tfm_integration_guide.md |
| 26 | docs/user_guides/tfm_ns_client_identification.md |
| 27 | docs/user_guides/tfm_secure_boot.md |
| 28 | |
| 29 | .. toctree:: |
| 30 | :maxdepth: 2 |
| 31 | :caption: Secure services |
| 32 | :glob: |
| 33 | :hidden: |
| 34 | |
| 35 | docs/user_guides/services/* |
| 36 | |
| 37 | .. toctree:: |
| 38 | :maxdepth: 2 |
| 39 | :caption: Components |
| 40 | :glob: |
| 41 | :hidden: |
| 42 | |
| 43 | lib/** |
| 44 | |
| 45 | .. toctree:: |
| 46 | :maxdepth: 2 |
| 47 | :caption: Target platforms |
| 48 | :glob: |
| 49 | :hidden: |
| 50 | |
| 51 | platform/** |
| 52 | |
| 53 | .. toctree:: |
| 54 | :caption: Design documents |
| 55 | :maxdepth: 2 |
| 56 | :glob: |
| 57 | :hidden: |
| 58 | |
| 59 | docs/design_documents/* |
| 60 | |
| 61 | .. toctree:: |
| 62 | :caption: Draft design documents |
| 63 | :maxdepth: 2 |
| 64 | :glob: |
| 65 | :hidden: |
| 66 | |
| 67 | docs/design_documents/drafts/* |
| 68 | |
| 69 | .. toctree:: |
| 70 | :caption: Rejected design documents |
| 71 | :maxdepth: 2 |
| 72 | :glob: |
| 73 | :hidden: |
| 74 | |
| 75 | docs/design_documents/rejected/* |
| 76 | |
| 77 | .. mdinclude:: readme.md |
| 78 | |
| 79 | ----------- |
| 80 | |
| 81 | :Copyright: Copyright (c) 2019, Arm Limited. All rights reserved. |