doc: add search engine for API
authorAideen McLoughlin <aideen.mcloughlin@intel.com>
Thu, 27 Jun 2019 13:58:19 +0000 (14:58 +0100)
committerThomas Monjalon <thomas@monjalon.net>
Mon, 8 Jul 2019 20:13:20 +0000 (22:13 +0200)
I modified the API config file to incorporate a search button into the
API documentation page.

Signed-off-by: Aideen McLoughlin <aideen.mcloughlin@intel.com>
doc/api/doxy-api.conf.in
mk/rte.sdkdoc.mk

index 1fa064b..908cee8 100644 (file)
@@ -84,7 +84,7 @@ ALPHABETICAL_INDEX      = NO
 
 HTML_TIMESTAMP          = NO
 HTML_DYNAMIC_SECTIONS   = YES
-SEARCHENGINE            = NO
+SEARCHENGINE            = YES
 SORT_MEMBER_DOCS        = NO
 SOURCE_BROWSER          = YES
 
index c44db64..fd77e41 100644 (file)
@@ -56,6 +56,7 @@ api-html: $(API_EXAMPLES)
 .PHONY: api-html-clean
 api-html-clean:
        $(Q)rm -f $(API_EXAMPLES)
+       $(Q)rm -rf $(RTE_OUTPUT)/doc/html/api/search
        $(Q)rm -f $(RTE_OUTPUT)/doc/html/api/*
        $(Q)rmdir -p --ignore-fail-on-non-empty $(RTE_OUTPUT)/doc/html/api 2>&- || true