[v2] doc: add search feature to API doc page
Checks
Commit Message
I modified the API config file to incorperate a search button into the
API documentation page.
Signed-off-by: A.McLoughlin <aideen.mcloughlin@intel.com>
---
V2:
Adding description for patch
---
doc/api/doxy-api.conf.in | 2 +-
mk/rte.sdkdoc.mk | 1 +
2 files changed, 2 insertions(+), 1 deletion(-)
Comments
27/06/2019 15:58, A.McLoughlin:
> I modified the API config file to incorperate a search button into the
> API documentation page.
>
> Signed-off-by: A.McLoughlin <aideen.mcloughlin@intel.com>
Applied, thanks
@@ -83,7 +83,7 @@ ALPHABETICAL_INDEX = NO
HTML_TIMESTAMP = NO
HTML_DYNAMIC_SECTIONS = YES
-SEARCHENGINE = NO
+SEARCHENGINE = YES
SORT_MEMBER_DOCS = NO
SOURCE_BROWSER = YES
@@ -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