summaryrefslogtreecommitdiffstats
path: root/Makefile
diff options
context:
space:
mode:
authorjdenisco <jdenisco@cisco.com>2018-09-24 14:59:33 -0400
committerDamjan Marion <dmarion@me.com>2018-09-24 21:37:00 +0000
commit3138d723091234a3534baa8b1bbaad31df6fb8d6 (patch)
tree6d739fda1349dd98cdb6d0ef54743015b97c3fd0 /Makefile
parentedb3a9bca826ddaaf5f3c7ee83f9e474bd2a2e11 (diff)
Add the sphinx docs build options
Change-Id: If7ac5b41ca4ac602a100b616b37d07f658fd6a90 Signed-off-by: jdenisco <jdenisco@cisco.com>
Diffstat (limited to 'Makefile')
-rw-r--r--Makefile19
1 files changed, 19 insertions, 0 deletions
diff --git a/Makefile b/Makefile
index a9bea9d254c..36c7a5a741d 100644
--- a/Makefile
+++ b/Makefile
@@ -217,6 +217,9 @@ help:
@echo " doxygen - (re)generate documentation"
@echo " bootstrap-doxygen - setup Doxygen dependencies"
@echo " wipe-doxygen - wipe all generated documentation"
+ @echo " docs - Build the Sphinx documentation"
+ @echo " docs-venv - Build the virtual environment for the Sphinx docs"
+ @echo " docs-clean - Remove the generated files from the Sphinx docs"
@echo " test-doc - generate documentation for test framework"
@echo " test-wipe-doc - wipe documentation for test framework"
@echo " test-cov - generate code coverage report for test framework"
@@ -537,6 +540,22 @@ doxygen:
wipe-doxygen:
$(call make-doxy)
+# Sphinx Documents
+export DOCS_DIR = $(WS_ROOT)/docs
+export VENV_DIR = $(WS_ROOT)/sphinx_venv
+export SPHINX_SCRIPTS_DIR = $(WS_ROOT)/docs/scripts
+
+.PHONY: docs-venv docs docs-clean
+
+docs-venv:
+ @($(SPHINX_SCRIPTS_DIR)/sphinx-make.sh venv)
+
+docs: $(DOCS_DIR)
+ @($(SPHINX_SCRIPTS_DIR)/sphinx-make.sh html)
+
+docs-clean:
+ @($(SPHINX_SCRIPTS_DIR)/sphinx-make.sh clean)
+
verify: install-dep $(BR)/.deps.ok install-ext-deps
$(call banner,"Building for PLATFORM=vpp using gcc")
@make -C build-root PLATFORM=vpp TAG=vpp wipe-all install-packages