X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=Makefile;h=36c7a5a741d00aaed10f1837797a6cb8171e3c58;hb=94495f2a6a68ac2202b7715ce09620f1ba6fe673;hp=a9bea9d254c02f690f647122d63dfb66ca324fd7;hpb=4a6cb83d334e391f85332ea38a2e467ac7743e4b;p=vpp.git 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