[spp] [PATCH 15/15] makefile: add target for compile rst documents

ogawa.yasufumi at lab.ntt.co.jp ogawa.yasufumi at lab.ntt.co.jp
Thu Feb 1 05:05:01 CET 2018


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

Add targets for compile and clean RST documents.

  # Compile RST documents.
  $ make doc-html

  # Clean documents.
  $ make doc-clean

This update includes a change for .gitignore to exclude generated
documents in 'docs/guides/_build'.

Signed-off-by: Yasufumi Ogawa <ogawa.yasufumi at lab.ntt.co.jp>
---
 .gitignore | 1 +
 Makefile   | 9 +++++++++
 2 files changed, 10 insertions(+)

diff --git a/.gitignore b/.gitignore
index a01ee28..08ac066 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1 +1,2 @@
 .*.swp
+docs/guides/_build/*
diff --git a/Makefile b/Makefile
index fa6dcd3..9b198b7 100644
--- a/Makefile
+++ b/Makefile
@@ -43,3 +43,12 @@ include $(RTE_SDK)/mk/rte.vars.mk
 DIRS-y += src
 
 include $(RTE_SDK)/mk/rte.extsubdir.mk
+
+# Compile RST documents
+.PHONY: doc-html
+doc-html:
+	sh docs/guides/compile-doc.sh doc-html
+
+.PHONY: doc-clean
+doc-clean:
+	sh docs/guides/compile-doc.sh clean
-- 
2.7.4



More information about the spp mailing list