From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <ogawa.yasufumi@lab.ntt.co.jp>
Received: from mogw0924.ocn.ad.jp (mogw0924.ocn.ad.jp [153.149.227.30])
 by dpdk.org (Postfix) with ESMTP id 4EABE1B8AE
 for <spp@dpdk.org>; Thu,  1 Feb 2018 05:05:29 +0100 (CET)
Received: from mf-smf-ucb032c2 (mf-smf-ucb032c2.ocn.ad.jp [153.153.66.204])
 by mogw0924.ocn.ad.jp (Postfix) with ESMTP id CD06FB0023A;
 Thu,  1 Feb 2018 13:05:27 +0900 (JST)
Received: from ntt.pod01.mv-mta-ucb021 ([153.149.142.84])
 by mf-smf-ucb032c2 with ESMTP
 id h67neWiF7dZK5h67re4QOV; Thu, 01 Feb 2018 13:05:27 +0900
Received: from smtp.ocn.ne.jp ([153.149.227.166])
 by ntt.pod01.mv-mta-ucb021 with 
 id 5G5R1x00E3c2f7501G5RQE; Thu, 01 Feb 2018 04:05:27 +0000
Received: from localhost.localdomain (sp1-66-99-86.msc.spmode.ne.jp
 [1.66.99.86]) by smtp.ocn.ne.jp (Postfix) with ESMTPA;
 Thu,  1 Feb 2018 13:05:25 +0900 (JST)
From: ogawa.yasufumi@lab.ntt.co.jp
To: spp@dpdk.org,
	ferruh.yigit@intel.com
Cc: Yasufumi Ogawa <ogawa.yasufumi@lab.ntt.co.jp>
Date: Thu,  1 Feb 2018 13:05:00 +0900
Message-Id: <20180201040501.8004-14-ogawa.yasufumi@lab.ntt.co.jp>
X-Mailer: git-send-email 2.13.1
In-Reply-To: <20180201040501.8004-1-ogawa.yasufumi@lab.ntt.co.jp>
References: <20180201040501.8004-1-ogawa.yasufumi@lab.ntt.co.jp>
Subject: [spp] [PATCH 14/15] docs: add compile script for rst documentation
X-BeenThere: spp@dpdk.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: Soft Patch Panel <spp.dpdk.org>
List-Unsubscribe: <https://dpdk.org/ml/options/spp>,
 <mailto:spp-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://dpdk.org/ml/archives/spp/>
List-Post: <mailto:spp@dpdk.org>
List-Help: <mailto:spp-request@dpdk.org?subject=help>
List-Subscribe: <https://dpdk.org/ml/listinfo/spp>,
 <mailto:spp-request@dpdk.org?subject=subscribe>
X-List-Received-Date: Thu, 01 Feb 2018 04:05:29 -0000

From: Yasufumi Ogawa <ogawa.yasufumi@lab.ntt.co.jp>

Add shell script for compile or clean rst documents. It is intended to
use from project's Makefile. Currently, this script support only html
and not pdf or other formats.

Usage:
  # Compile html documents
  $ docs/guides/compile-doc.sh doc-html

  # Clean documents generated in docs/guides/_build
  $ docs/guides/compile-doc.sh clean

Signed-off-by: Yasufumi Ogawa <ogawa.yasufumi@lab.ntt.co.jp>
---
 docs/guides/compile-doc.sh | 9 +++++++++
 1 file changed, 9 insertions(+)
 create mode 100644 docs/guides/compile-doc.sh

diff --git a/docs/guides/compile-doc.sh b/docs/guides/compile-doc.sh
new file mode 100644
index 0000000..0db5e45
--- /dev/null
+++ b/docs/guides/compile-doc.sh
@@ -0,0 +1,9 @@
+#!/bin/sh
+
+cd `dirname ${0}`
+
+if [ $1 = 'doc-html' ]; then
+	make html
+elif [ $1 = 'clean' ]; then
+	make clean
+fi
-- 
2.7.4