diff options
| author | Jan Eilers <jan.eilers@arm.com> | 2021-01-27 20:04:41 +0000 |
|---|---|---|
| committer | Jan Eilers <jan.eilers@arm.com> | 2021-02-01 17:06:24 +0000 |
| commit | 06fabe12d7d115045517880bae78a4b973af7547 (patch) | |
| tree | 41700520a6da284301ae99d03657f1899d975d0b /docs/Doxyfile | |
| parent | 85d3671618f0d40b71ebbc80373389140390c2cd (diff) | |
| download | armnn-06fabe12d7d115045517880bae78a4b973af7547.tar.gz | |
IVGCVSW-5605 Doxygen: Use readme.md as mainpage in doxygen
* Gives the readme file an update
* Removes introduction.dox
* Adds FAQ to doxygen
Signed-off-by: Jan Eilers <jan.eilers@arm.com>
Change-Id: Ibb67e7f2cac7e55556295eb7851c616561b17042
Diffstat (limited to 'docs/Doxyfile')
| -rw-r--r-- | docs/Doxyfile | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/docs/Doxyfile b/docs/Doxyfile index ee75769f82..e769e01b52 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -665,7 +665,7 @@ GENERATE_BUGLIST = YES # the documentation. # The default value is: YES. -GENERATE_DEPRECATEDLIST= YES +GENERATE_DEPRECATEDLIST= NO # The ENABLED_SECTIONS tag can be used to enable conditional documentation # sections, marked by \if <section_label> ... \endif and \cond <section_label> @@ -813,8 +813,7 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = ./docs/00_introduction.dox \ - ./docs/01_parsers.dox \ +INPUT = ./docs/01_parsers.dox \ ./docs/02_deserializer_serializer.dox \ ./docs/03_converter_quantizer.dox \ ./docs/04_backends.dox \ @@ -824,7 +823,9 @@ INPUT = ./docs/00_introduction.dox \ ./tests/ \ ./docs/ \ ./delegate/include \ - ./delegate/src/armnn_external_delegate.cpp + ./delegate/src/armnn_external_delegate.cpp \ + ./README.md \ + ./docs/FAQ.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 @@ -1016,7 +1017,7 @@ FILTER_SOURCE_PATTERNS = # (index.html). This can be useful if you have a project on for instance GitHub # and want to reuse the introduction page also for the doxygen output. -USE_MDFILE_AS_MAINPAGE = +USE_MDFILE_AS_MAINPAGE = ./README.md #--------------------------------------------------------------------------- # Configuration options related to source browsing |