X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=docs%2FMakefile;h=ca4a3acdb9c27d1bd167f0d767f92ddaa22a3cdc;hb=9ad39c026c8a3c945a7003c4aa4f5cb1d4c80160;hp=430877792a8a146ff91b3fa8e9c78e45f6768d54;hpb=3bfeff7a9812c025637ee232cca03a6f083bdbc6;p=vpp.git

diff --git a/docs/Makefile b/docs/Makefile
index 430877792a8..ca4a3acdb9c 100644
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -1,20 +1,102 @@
 # Minimal makefile for Sphinx documentation
 #
+# We support MacOS for docs generation
+ifeq ($(shell uname),Darwin)
+OS_ID = darwin
+endif
+
+# These should be passed in by the root Makefile
+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
+OS_ID ?= $(shell grep '^ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g')
+OS_VERSION ?= $(shell grep '^VERSION_ID=' /etc/os-release  | cut -f2- -d= | sed -e 's/\"//g')
+PIP_VERSION ?= $(shell grep 'PIP_VERSION=' ${WS_ROOT}/test/Makefile | cut -d'=' -f2)
+PIP_TOOLS_VERSION ?= $(shell grep 'PIP_TOOLS_VERSION=' ${WS_ROOT}/test/Makefile | cut -d'=' -f2)
+
+PYTHON ?= "python3"
+
+DOC_DEB_DEPENDS = enchant
+DOC_RPM_DEPENDS = enchant
 
 # You can set these variables from the command line.
-SPHINXOPTS    =
-SPHINXBUILD   = sphinx-build
-SPHINXPROJ    = fdio-vpp
-SOURCEDIR     = .
-BUILDDIR      = _build
+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
+
 
 # Put it first so that "make" without argument is like "make help".
+.PHONY: help
 help:
-	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+	@( \
+	  . ${VENV_DIR}/bin/activate; \
+	  $(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
+else ifneq ("$(wildcard /etc/redhat-release)","")
+	@sudo yum install $(CONFIRM) $(DOC_RPM_DEPENDS)
+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:
+	@( \
+	    if [ ! -d ${VENV_DIR} ]; then \
+	      ${PYTHON} -m venv ${VENV_DIR}; \
+	      . ${VENV_DIR}/bin/activate; \
+	      ${PYTHON} -m pip install pip==${PIP_VERSION}; \
+	      ${PYTHON} -m pip install pip-tools==${PIP_TOOLS_VERSION}; \
+	      ${PYTHON} -m pip install -r ${WS_ROOT}/test/requirements-3.txt; \
+	    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: docs
+docs: clean venv ${BUILDDIR_SRC}
+	@( \
+	  . ${VENV_DIR}/bin/activate; \
+	  make -C ${SCRIPTS_DIR} generate && \
+	  $(SPHINXBUILD) $(SPHINXOPTS) -b html $(BUILDDIR_SRC) $(BUILDDIR_OUT); \
+	)
+
+.PHONY: clean
+clean:
+	@rm -rf $(BUILDDIR)
+	@make -C ${SCRIPTS_DIR} clean
 
-.PHONY: help Makefile
+.PHONY: build
+build: docs
 
-# Catch-all target: route all unknown targets to Sphinx using the new
-# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
-%: Makefile
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)