[dpdk-dev] [PATCH] doc: add search feature to API doc page

[dpdk-dev] [PATCH] doc: add search feature to API doc page

[A.McLoughlin]

Signed-off-by: A.McLoughlin <aideen.mcloughlin@intel.com>
---
 doc/api/doxy-api.conf.in | 2 +-
 mk/rte.sdkdoc.mk         | 1 +
 2 files changed, 2 insertions(+), 1 deletion(-)

diff --git a/doc/api/doxy-api.conf.in b/doc/api/doxy-api.conf.in
index 1fa064b36..908cee8f7 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 c44db6447..fd77e4186 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
 
-- 
2.17.1

--------------------------------------------------------------
Intel Research and Development Ireland Limited
Registered in Ireland
Registered Office: Collinstown Industrial Park, Leixlip, County Kildare
Registered Number: 308263


This e-mail and any attachments may contain confidential material for the sole
use of the intended recipient(s). Any review or distribution by others is
strictly prohibited. If you are not the intended recipient, please contact the
sender and delete all copies.

[dpdk-dev] [PATCH v2] doc: add search feature to API doc page

[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>

---
V2:
  Adding description for patch
---
 doc/api/doxy-api.conf.in | 2 +-
 mk/rte.sdkdoc.mk         | 1 +
 2 files changed, 2 insertions(+), 1 deletion(-)

diff --git a/doc/api/doxy-api.conf.in b/doc/api/doxy-api.conf.in
index b9896cb63..20188a42e 100644
--- a/doc/api/doxy-api.conf.in
+++ b/doc/api/doxy-api.conf.in
@@ -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
 
diff --git a/mk/rte.sdkdoc.mk b/mk/rte.sdkdoc.mk
index c44db6447..fd77e4186 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
 
-- 
2.17.1

--------------------------------------------------------------
Intel Research and Development Ireland Limited
Registered in Ireland
Registered Office: Collinstown Industrial Park, Leixlip, County Kildare
Registered Number: 308263


This e-mail and any attachments may contain confidential material for the sole
use of the intended recipient(s). Any review or distribution by others is
strictly prohibited. If you are not the intended recipient, please contact the
sender and delete all copies.

Re: [dpdk-dev] [PATCH v2] doc: add search feature to API doc page

[Thomas Monjalon]

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