diff mbox series

[v2] doc: add search feature to API doc page

Message ID 20190627135819.22175-1-aideen.mcloughlin@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers show
Series [v2] doc: add search feature to API doc page | expand

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK
ci/intel-Performance-Testing success Performance Testing PASS
ci/mellanox-Performance-Testing success Performance Testing PASS

Commit Message

A.McLoughlin June 27, 2019, 1:58 p.m. UTC
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

Thomas Monjalon July 8, 2019, 8:12 p.m. UTC | #1
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
diff mbox series

Patch

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