diff options
| author | Jan Eilers <jan.eilers@arm.com> | 2021-02-08 09:23:21 +0000 |
|---|---|---|
| committer | Jan Eilers <jan.eilers@arm.com> | 2021-02-08 09:23:21 +0000 |
| commit | 72a9929d1ae37a9c32a0c51eb8491e65c3d1add2 (patch) | |
| tree | 1d1a8261e5ed20e93d7bbff4ac1dfa284253ea4c /docs | |
| parent | c5c40fef3d4b3de5d1aa26c1c4dc72dcd74a8bc6 (diff) | |
| download | armnn-72a9929d1ae37a9c32a0c51eb8491e65c3d1add2.tar.gz | |
IVGCVSW-5605 Doxygen: Add remaining guides to doxygen
* Integrates the debian package installation guide
* Integrates the AndroidNDK guide
* Integrates the cross compile guide
Signed-off-by: Jan Eilers <jan.eilers@arm.com>
Change-Id: I2243b15ee3f8e976789494199f12f3cc0fd5f00d
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/02_build_guides.dox | 15 | ||||
| -rw-r--r-- | docs/Doxyfile | 11 |
2 files changed, 19 insertions, 7 deletions
diff --git a/docs/02_build_guides.dox b/docs/02_build_guides.dox index 35abf3229e..e61354dd54 100644 --- a/docs/02_build_guides.dox +++ b/docs/02_build_guides.dox @@ -6,11 +6,11 @@ namespace armnn { /** -@page buildguides Build Guides +@page buildguides Installation and build Guides @tableofcontents -This page links all guides to build and/or install Arm NN tools. Some of these guides are not hosted in our -repository and will lead you to guides on +This page links all guides to build and/or install Arm NN tools hosted in our repository. +You can find additional tutorials on https://developer.arm.com/solutions/machine-learning-on-arm/developer-material/how-to-guides Arm NN is written using portable C++14 and the build system uses [CMake](https://cmake.org/), therefore it is possible @@ -19,8 +19,17 @@ to build for a wide variety of target platforms, from a wide variety of host env Arm NN is managed by a single CMake project. That allows you to build multiple tools at once by combining the CMake options from different build guides. +## Installation via APT Repository + - @subpage md_InstallationViaAptRepository + ## TfLite Delegate build guide - @subpage md_delegate_BuildGuideNative +## Android NDK and Arm NN + - @subpage md_BuildGuideAndroidNDK + +## Crosscompile Guide for Arm NN + - @subpage md_BuildGuideCrossCompilation + **/ }
\ No newline at end of file diff --git a/docs/Doxyfile b/docs/Doxyfile index a8a5b5cf13..cfd2e670bc 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -820,14 +820,15 @@ INPUT = ./docs/01_00_software_tools.dox \ ./docs/02_build_guides.dox \ ./docs/03_use_guides.dox \ ./docs/04_contributor.dox \ - ./src/armnnQuantizer/README.md \ - ./src/armnnConverter/README.md \ + ./docs/FAQ.md \ ./tests/ImageCSVFileGenerator/README.md \ ./tests/ImageTensorGenerator/README.md \ ./tests/ModelAccuracyTool-Armnn/README.md \ ./python/pyarmnn/README.md \ ./include/ \ ./src/ \ + ./src/armnnQuantizer/README.md \ + ./src/armnnConverter/README.md \ ./src/backends/README.md \ ./src/dynamic/README.md \ ./tests/ \ @@ -836,8 +837,10 @@ INPUT = ./docs/01_00_software_tools.dox \ ./delegate/BuildGuideNative.md \ ./delegate/IntegrateDelegateIntoPython.md \ ./README.md \ - ./docs/FAQ.md \ - ./ContributorGuide.md + ./InstallationViaAptRepository.md \ + ./ContributorGuide.md \ + ./BuildGuideAndroidNDK.md \ + ./BuildGuideCrossCompilation.md # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses |