make test: create virtualenv under /test/
[vpp.git] / test / doc / Makefile
index 809abef..be070e1 100644 (file)
@@ -3,10 +3,10 @@
 
 # You can set these variables from the command line.
 SPHINXOPTS    =
-SRC_DOC_DIR = $(WS_ROOT)/test/doc
+SRC_DOC_DIR = $(TEST_DIR)/doc
 SPHINXBUILD = sphinx-build
 PAPER         =
-BUILD_DOC_ROOT = $(BR)/test-doc
+BUILD_DOC_ROOT = $(TEST_DIR)/doc
 BUILD_DOC_DIR = $(BUILD_DOC_ROOT)/build
 API_DOC_GEN_DIR = $(BUILD_DOC_ROOT)/apidoc
 
@@ -16,8 +16,7 @@ PAPEROPT_letter = -D latex_paper_size=letter
 ALLSPHINXOPTS   = -d $(BUILD_DOC_DIR)/.sphinx-cache $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(API_DOC_GEN_DIR) -c $(SRC_DOC_DIR)
 # the i18n builder cannot share the environment and doctrees with the others
 I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
-INDEX_REL_PATH:=$(shell realpath --relative-to=$(API_DOC_GEN_DIR) $(SRC_DOC_DIR)/index.rst)
-IN_VENV:=$(shell if pip -V | grep "virtualenv" 2>&1 > /dev/null; then echo 1; else echo 0; fi)
+IN_VENV:=$(shell if pip -V | grep "venv" 2>&1 > /dev/null; then echo 1; else echo 0; fi)
 
 .PHONY: verify-virtualenv
 verify-virtualenv:
@@ -28,9 +27,10 @@ endif
 .PHONY: regen-api-doc
 regen-api-doc: verify-virtualenv
        @mkdir -p $(API_DOC_GEN_DIR)
-       #@echo ".. include:: $(INDEX_REL_PATH)" > $(API_DOC_GEN_DIR)/index.rst
        @cp $(SRC_DOC_DIR)/index.rst $(API_DOC_GEN_DIR)
-       sphinx-apidoc -o $(API_DOC_GEN_DIR) ..
+       @cp $(SRC_DOC_DIR)/indices.rst $(API_DOC_GEN_DIR)
+       @cp $(SRC_DOC_DIR)/overview.rst $(API_DOC_GEN_DIR)
+       sphinx-apidoc -o $(API_DOC_GEN_DIR) -H "Module documentation" ..
 
 .PHONY: help
 help: