aboutsummaryrefslogtreecommitdiff
path: root/docs/04_contributor.dox
diff options
context:
space:
mode:
authorNikhil Raj <nikhil.raj@arm.com>2021-11-10 15:01:25 +0000
committerNikhil Raj Arm <nikhil.raj@arm.com>2021-11-11 17:38:25 +0000
commit608c8366c0979a14607ec77d06771d6c994332b2 (patch)
tree32a492099a99c7033b92d6728f18f032028500c6 /docs/04_contributor.dox
parentf596ad0ee83e23b3c6ad80a574be4fe7bdd4826e (diff)
downloadarmnn-608c8366c0979a14607ec77d06771d6c994332b2.tar.gz
Remove use guide section from doxygen
* This guide has now been moved to the Quick Start section in doxygen Signed-off-by: Nikhil Raj <nikhil.raj@arm.com> Change-Id: I758915c43f0e9e116f7308482db34d560d7ba0d9
Diffstat (limited to 'docs/04_contributor.dox')
-rw-r--r--docs/04_contributor.dox39
1 files changed, 39 insertions, 0 deletions
diff --git a/docs/04_contributor.dox b/docs/04_contributor.dox
new file mode 100644
index 0000000000..5cbb6c3b8c
--- /dev/null
+++ b/docs/04_contributor.dox
@@ -0,0 +1,39 @@
+/// Copyright (c) 2021 ARM Limited and Contributors. All rights reserved.
+///
+/// SPDX-License-Identifier: MIT
+///
+
+namespace armnn
+{
+/**
+
+@page contribguides Contribution Guides
+@tableofcontents
+
+This is a collection of guides that should help you contribute code to Arm NN. Before you get started, please
+take a look into our /ref md_Contributor_Guide section.
+
+ - @subpage md_src_backends_README \n
+ This guide explains how to add your own backend to Arm NN. This might be useful if you would like to accelerate neural
+ networks on hardware that Arm NN currently doesn't support.
+
+
+ - @subpage md_src_dynamic_README \n
+ Arm NN allows you to load a backend dynamically on runtime. To find out how that can be done take a look at this guide.
+
+**/
+}
+
+
+/// Create pages for each tool so they appear nicely in the doxygen tree-view. Subpages are not listed there.
+/// Also we can overwrite the page name this way.
+namespace armnn
+{
+/**
+
+@page md_src_backends_README Backend Developer Guide
+
+@page md_src_dynamic_README Dynamically loadable Backend
+
+**/
+}