aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJan Eilers <jan.eilers@arm.com>2021-01-29 09:50:36 +0000
committerJan Eilers <jan.eilers@arm.com>2021-02-02 11:26:49 +0000
commitd97823751818b32c5e9bc2559ccfa26f818dc1a9 (patch)
tree130ef6b16c87b7adcd1c7176672b8107678a2151
parent8cded51ebfca65a3a07b3927a2a78ea54d1c1cd8 (diff)
downloadarmnn-d97823751818b32c5e9bc2559ccfa26f818dc1a9.tar.gz
IVGCVSW-5605 Doxygen: Add PyArmNN to Doxygen docu
Signed-off-by: Jan Eilers <jan.eilers@arm.com> Change-Id: I43082950c55375f62ecd30236d1c475e4ca89faf
-rw-r--r--docs/00_software_tools.dox4
-rw-r--r--docs/Doxyfile3
-rw-r--r--python/pyarmnn/README.md2
3 files changed, 7 insertions, 2 deletions
diff --git a/docs/00_software_tools.dox b/docs/00_software_tools.dox
index 839e691cdf..e71b3dc332 100644
--- a/docs/00_software_tools.dox
+++ b/docs/00_software_tools.dox
@@ -13,6 +13,8 @@ other helpful information in each section.
@subpage parsers
+@subpage md_python_pyarmnn_README
+
@subpage serializer
@subpage deserializer
@@ -37,6 +39,8 @@ namespace armnn
{
/**
+@page md_python_pyarmnn_README PyArmNN
+
@page md_src_armnnQuantizer_README Quantizer
@page md_src_armnnConverter_README Converter
diff --git a/docs/Doxyfile b/docs/Doxyfile
index 98b2d472b9..3cf4ac5517 100644
--- a/docs/Doxyfile
+++ b/docs/Doxyfile
@@ -822,6 +822,7 @@ INPUT = ./docs/00_software_tools.dox \
./tests/ImageCSVFileGenerator/README.md \
./tests/ImageTensorGenerator/README.md \
./tests/ModelAccuracyTool-Armnn/README.md \
+ ./python/pyarmnn/README.md \
./include/ \
./src/ \
./tests/ \
@@ -964,7 +965,7 @@ EXAMPLE_RECURSIVE = NO
# that contain images that are to be included in the documentation (see the
# \image command).
-IMAGE_PATH =
+IMAGE_PATH = python/pyarmnn/
# The INPUT_FILTER tag can be used to specify a program that doxygen should
# invoke to filter for each input file. Doxygen will invoke the filter program
diff --git a/python/pyarmnn/README.md b/python/pyarmnn/README.md
index bc2ebd0388..aea2e42377 100644
--- a/python/pyarmnn/README.md
+++ b/python/pyarmnn/README.md
@@ -1,4 +1,4 @@
-# About PyArmNN
+# PyArmNN
PyArmNN is a python extension for [Arm NN SDK](https://developer.arm.com/ip-products/processors/machine-learning/arm-nn).
PyArmNN provides interface similar to Arm NN C++ Api.