summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAideen McLoughlin <aideen.mcloughlin@intel.com>2019-06-27 14:58:19 +0100
committerThomas Monjalon <thomas@monjalon.net>2019-07-08 22:13:20 +0200
commit92d6c874d33dbbd3ace7c06a3490a61ff6641d61 (patch)
tree641e999d2b92330c444200fbdcf76518e0fe76a9
parent42490f387372d3cd86eef1427f9c9d7b60133493 (diff)
downloaddpdk-92d6c874d33dbbd3ace7c06a3490a61ff6641d61.zip
dpdk-92d6c874d33dbbd3ace7c06a3490a61ff6641d61.tar.gz
dpdk-92d6c874d33dbbd3ace7c06a3490a61ff6641d61.tar.xz
doc: add search engine for API
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>
-rw-r--r--doc/api/doxy-api.conf.in2
-rw-r--r--mk/rte.sdkdoc.mk1
2 files changed, 2 insertions, 1 deletions
diff --git a/doc/api/doxy-api.conf.in b/doc/api/doxy-api.conf.in
index 1fa064b..908cee8 100644
--- a/doc/api/doxy-api.conf.in
+++ b/doc/api/doxy-api.conf.in
@@ -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
diff --git a/mk/rte.sdkdoc.mk b/mk/rte.sdkdoc.mk
index c44db64..fd77e41 100644
--- a/mk/rte.sdkdoc.mk
+++ b/mk/rte.sdkdoc.mk
@@ -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