X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=docs%2FMakefile;h=01e8d659bffd41aa81b2d2faafee4c1c7051973d;hb=b116bf8f37146b9f7ef3d3e1ba73dca194b27237;hp=71ee034b331d49de3a141fccad814f83f041876d;hpb=e74c04fc9fb2600470fe79a69d3ec6b0db95faec;p=vpp.git diff --git a/docs/Makefile b/docs/Makefile index 71ee034b331..01e8d659bff 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -21,7 +21,6 @@ WS_ROOT ?= $(CURDIR)/.. BR ?= $(WS_ROOT)/build-root DOCS_DIR ?= $(WS_ROOT)/docs -VENV_DIR ?= $(DOCS_DIR)/venv SPHINX_SCRIPTS_DIR ?= $(WS_ROOT)/docs/scripts # Work out the OS if we haven't already @@ -40,11 +39,11 @@ endif SPHINXOPTS = --keep-going -n -W SPHINXBUILD = sphinx-build SPHINXPROJ = fdio-vpp -SOURCEDIR = . BUILDDIR = ${BR}/docs BUILDDIR_SRC = ${BUILDDIR}/src BUILDDIR_OUT = ${BUILDDIR}/html SCRIPTS_DIR = _scripts +VENV_DIR ?= $(BUILDDIR)/venv # Put it first so that "make" without argument is like "make help". @@ -55,28 +54,6 @@ help: $(SPHINXBUILD) --help ;\ ) -.PHONY: checkdeps -checkdeps: - @echo "Checking whether dependencies for Docs are installed..." -ifeq ($(OS_ID),ubuntu) - @set -e; inst=; \ - for i in $(DOC_DEB_DEPENDS); do \ - dpkg-query --show $$i >/dev/null 2>&1 || inst="$$inst $$i"; \ - done; \ - if [ "$$inst" ]; then \ - sudo apt-get update; \ - sudo apt-get $(CONFIRM) $(FORCE) install $$inst; \ - fi -endif - -.PHONY: spell -spell: clean checkdeps venv ${BUILDDIR_SRC} - @( \ - . ${VENV_DIR}/bin/activate; \ - make -C ${SCRIPTS_DIR} generate && \ - $(SPHINXBUILD) -b spelling $(SPHINXOPTS) $(BUILDDIR_SRC) $(BUILDDIR_OUT); \ - ) - .PHONY: venv venv: @( \ @@ -89,22 +66,30 @@ venv: fi; \ ) -${BUILDDIR_SRC}: - @mkdir -p ${BUILDDIR_SRC} - @cp -r $(SOURCEDIR) ${BUILDDIR_SRC} - @cd ${BUILDDIR_SRC} && find . -type l -exec cp --remove-destination -L ${DOCS_DIR}/{} {} \; +.PHONY: spell +spell: venv + @( \ + . ${VENV_DIR}/bin/activate; \ + make -C ${SCRIPTS_DIR} generate && \ + $(SPHINXBUILD) -b spelling $(SPHINXOPTS) $(BUILDDIR_SRC) $(BUILDDIR_OUT); \ + ) + +.PHONY: rebuild-spell +rebuild-spell: clean spell .PHONY: docs -docs: clean venv ${BUILDDIR_SRC} +docs: venv @( \ . ${VENV_DIR}/bin/activate; \ make -C ${SCRIPTS_DIR} generate && \ $(SPHINXBUILD) $(SPHINXOPTS) -b html $(BUILDDIR_SRC) $(BUILDDIR_OUT); \ ) +.PHONY: rebuild +rebuild: clean docs + .PHONY: clean clean: - @rm -rf $(BUILDDIR) ${VENV_DIR} @make -C ${SCRIPTS_DIR} clean .PHONY: build