From patchwork Thu Jun 27 13:58:19 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "A.McLoughlin" X-Patchwork-Id: 55503 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@dpdk.org Delivered-To: patchwork@dpdk.org Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 7A71D2C30; Thu, 27 Jun 2019 15:58:27 +0200 (CEST) Received: from mga01.intel.com (mga01.intel.com [192.55.52.88]) by dpdk.org (Postfix) with ESMTP id D05D92C12 for ; Thu, 27 Jun 2019 15:58:25 +0200 (CEST) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga001.fm.intel.com ([10.253.24.23]) by fmsmga101.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 27 Jun 2019 06:58:24 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.63,423,1557212400"; d="scan'208";a="183458172" Received: from silpixa00389822.ir.intel.com (HELO silpixa00389822.ger.corp.intel.com) ([10.237.223.42]) by fmsmga001.fm.intel.com with ESMTP; 27 Jun 2019 06:58:23 -0700 From: "A.McLoughlin" To: dev@dpdk.org Cc: marko.kovacevic@intel.com, john.mcnamara@intel.com, ferruh.yigit@intel.com, "A.McLoughlin" Date: Thu, 27 Jun 2019 14:58:19 +0100 Message-Id: <20190627135819.22175-1-aideen.mcloughlin@intel.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20190627134653.21936-1-aideen.mcloughlin@intel.com> References: <20190627134653.21936-1-aideen.mcloughlin@intel.com> Subject: [dpdk-dev] [PATCH v2] doc: add search feature to API doc page X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" I modified the API config file to incorperate a search button into the API documentation page. Signed-off-by: A.McLoughlin --- 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