diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/01_00_quick_start.dox | 25 | ||||
-rw-r--r-- | docs/02_operator_list.dox (renamed from docs/05_operator_list.dox) | 0 | ||||
-rw-r--r-- | docs/03_build_guides.dox (renamed from docs/02_build_guides.dox) | 2 | ||||
-rw-r--r-- | docs/04_use_guides.dox (renamed from docs/03_use_guides.dox) | 0 | ||||
-rw-r--r-- | docs/05_contributor.dox (renamed from docs/04_contributor.dox) | 0 | ||||
-rw-r--r-- | docs/06_00_software_tools.dox (renamed from docs/01_00_software_tools.dox) | 0 | ||||
-rw-r--r-- | docs/06_01_parsers.dox (renamed from docs/01_01_parsers.dox) | 0 | ||||
-rw-r--r-- | docs/06_02_deserializer_serializer.dox (renamed from docs/01_02_deserializer_serializer.dox) | 0 | ||||
-rw-r--r-- | docs/06_03_delegate.dox (renamed from docs/01_03_delegate.dox) | 0 | ||||
-rw-r--r-- | docs/Doxyfile | 20 |
10 files changed, 37 insertions, 10 deletions
diff --git a/docs/01_00_quick_start.dox b/docs/01_00_quick_start.dox new file mode 100644 index 0000000000..a2a1efa50d --- /dev/null +++ b/docs/01_00_quick_start.dox @@ -0,0 +1,25 @@ +/// Copyright (c) 2021 ARM Limited and Contributors. All rights reserved. +/// +/// SPDX-License-Identifier: MIT +/// + +namespace armnn +{ +/** +@page quickstart Quick Start Guide + +On this page you can find guides which allow you to get setup and ready to run models with Arm NN quickly. +These guides rely on using the apt packages or prebuilt binaries from our release notes. We only have added a quick start guide that uses TfLite-Delegate. +More guides will be added in the future. + + - @subpage md_delegate_DelegateQuickStartGuide +**/ +} + +namespace armnn +{ +/** + +@page md_delegate_DelegateQuickStartGuide TfLite Delegate Quick Start Guide +**/ +} diff --git a/docs/05_operator_list.dox b/docs/02_operator_list.dox index 90aee130bf..90aee130bf 100644 --- a/docs/05_operator_list.dox +++ b/docs/02_operator_list.dox diff --git a/docs/02_build_guides.dox b/docs/03_build_guides.dox index e61354dd54..f193c9f0bd 100644 --- a/docs/02_build_guides.dox +++ b/docs/03_build_guides.dox @@ -6,7 +6,7 @@ namespace armnn { /** -@page buildguides Installation and build Guides +@page buildguides Build Guides @tableofcontents This page links all guides to build and/or install Arm NN tools hosted in our repository. diff --git a/docs/03_use_guides.dox b/docs/04_use_guides.dox index 1ecef4a215..1ecef4a215 100644 --- a/docs/03_use_guides.dox +++ b/docs/04_use_guides.dox diff --git a/docs/04_contributor.dox b/docs/05_contributor.dox index 5cbb6c3b8c..5cbb6c3b8c 100644 --- a/docs/04_contributor.dox +++ b/docs/05_contributor.dox diff --git a/docs/01_00_software_tools.dox b/docs/06_00_software_tools.dox index e560f44882..e560f44882 100644 --- a/docs/01_00_software_tools.dox +++ b/docs/06_00_software_tools.dox diff --git a/docs/01_01_parsers.dox b/docs/06_01_parsers.dox index 186ed6193a..186ed6193a 100644 --- a/docs/01_01_parsers.dox +++ b/docs/06_01_parsers.dox diff --git a/docs/01_02_deserializer_serializer.dox b/docs/06_02_deserializer_serializer.dox index 5d4dc43a74..5d4dc43a74 100644 --- a/docs/01_02_deserializer_serializer.dox +++ b/docs/06_02_deserializer_serializer.dox diff --git a/docs/01_03_delegate.dox b/docs/06_03_delegate.dox index b3caf8cbf8..b3caf8cbf8 100644 --- a/docs/01_03_delegate.dox +++ b/docs/06_03_delegate.dox diff --git a/docs/Doxyfile b/docs/Doxyfile index 3fc872eda2..1ddb3e3f08 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -813,14 +813,16 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = ./docs/01_00_software_tools.dox \ - ./docs/01_01_parsers.dox \ - ./docs/01_03_delegate.dox \ - ./docs/01_02_deserializer_serializer.dox \ - ./docs/02_build_guides.dox \ - ./docs/03_use_guides.dox \ - ./docs/04_contributor.dox \ - ./docs/05_operator_list.dox \ +INPUT = ./docs/01_00_quick_start.dox \ + ./docs/01_01_delegate_start_guide.dox \ + ./docs/02_operator_list.dox \ + ./docs/03_build_guides.dox \ + ./docs/04_use_guides.dox \ + ./docs/05_contributor.dox \ + ./docs/06_00_software_tools.dox \ + ./docs/06_01_parsers.dox \ + ./docs/06_02_deserializer_serializer.dox \ + ./docs/06_03_delegate.dox \ ./docs/FAQ.md \ ./tests/ImageCSVFileGenerator/README.md \ ./tests/ImageTensorGenerator/README.md \ @@ -835,7 +837,7 @@ INPUT = ./docs/01_00_software_tools.dox \ ./delegate/include \ ./delegate/src/armnn_external_delegate.cpp \ ./delegate/BuildGuideNative.md \ - ./delegate/IntegrateDelegateIntoPython.md \ + ./delegate/DelegateQuickStartGuide.md \ ./README.md \ ./InstallationViaAptRepository.md \ ./ContributorGuide.md \ |