[spp] [PATCH 14/15] docs: add compile script for rst documentation
ogawa.yasufumi at lab.ntt.co.jp
ogawa.yasufumi at lab.ntt.co.jp
Thu Feb 1 05:05:00 CET 2018
From: Yasufumi Ogawa <ogawa.yasufumi at 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 at 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
More information about the spp
mailing list