1 # Makefile for VPP Test documentation
5 SRC_DOC_DIR = $(TEST_DIR)/doc
6 SPHINXBUILD = sphinx-build
7 HTML_DOC_GEN_DIR = $(TEST_DOC_BR)/html
8 API_DOC_GEN_DIR = $(TEST_DOC_BR)/api
11 ALLSPHINXOPTS = -d $(TEST_DOC_BR)/.sphinx-cache $(SPHINXOPTS) $(API_DOC_GEN_DIR) -c $(SRC_DOC_DIR)
12 IN_VENV:=$(shell if pip -V | grep "venv" 2>&1 > /dev/null; then echo 1; else echo 0; fi)
14 .PHONY: verify-virtualenv
17 $(error TEST_DIR is not set)
20 $(error TEST_DOC_BR is not set)
23 $(error BUILD_TEST_SRC is not set)
26 $(error "Not running inside virtualenv (are you running 'make test-doc' from root?)")
30 regen-api-doc: verify-virtualenv
31 @mkdir -p $(API_DOC_GEN_DIR)
32 @cp $(SRC_DOC_DIR)/index.rst $(API_DOC_GEN_DIR)
33 @cp $(SRC_DOC_DIR)/indices.rst $(API_DOC_GEN_DIR)
34 @cp $(SRC_DOC_DIR)/overview.rst $(API_DOC_GEN_DIR)
35 sphinx-apidoc -o $(API_DOC_GEN_DIR) -H "Module documentation" $(BUILD_TEST_SRC)
38 html: regen-api-doc verify-virtualenv
39 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(HTML_DOC_GEN_DIR)