hs-test: cache docker build in local filesystem

[vpp.git] / docs / Makefile

diff --git a/docs/Makefile b/docs/Makefile
index c37b9ae..9f20935 100644 (file)
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -1,4 +1,15 @@
-# Minimal makefile for Sphinx documentation
+# Copyright (c) 2021 Cisco and/or its affiliates.
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at:
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
 #
 # We support MacOS for docs generation
 ifeq ($(shell uname),Darwin)
@@ -10,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
@@ -20,16 +30,20 @@ PIP_VERSION ?= $(shell grep 'PIP_VERSION=' ${WS_ROOT}/test/Makefile | cut -d'='
 PIP_TOOLS_VERSION ?= $(shell grep 'PIP_TOOLS_VERSION=' ${WS_ROOT}/test/Makefile | cut -d'=' -f2)
 
 PYTHON ?= "python3"
+PYTHON_VERSION_OK := $(shell $(PYTHON) -c "exec('import sys\nif sys.hexversion >= 0x03070000: print(\"true\")\nelse: print(\"false\")')")
+ifneq ($(PYTHON_VERSION_OK),true)
+$(error "ERROR: docs build requires python version >= to 3.7")
+endif
 
 # You can set these variables from the command line.
 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".
@@ -40,30 +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
-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:
        @( \
@@ -76,24 +66,31 @@ 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 && \
+         $(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
+       @$(MAKE) -C ${SCRIPTS_DIR} clean
 
 .PHONY: build
 build: docs
-