1e167a4aad
This patch makes the `make docs` directive incremental avoiding re-running the siphon when the source hasn't changed, and leveraging sphinx internal cache. It adds a `make rebuild-docs` directive for cases where this caching logic might break, e.g. in CI. The virtualenv doesn't also get recreated on each build, which might be enough when writing docs, provided automated process leverage its rebuild counterpart. Type: improvement Change-Id: Ie90de3adebeed017b249cad81c6c160719f71e8d Signed-off-by: Nathan Skrzypczak <nathan.skrzypczak@gmail.com> Signed-off-by: Dave Wallace <dwallacelf@gmail.com>
97 lines
2.8 KiB
Makefile
97 lines
2.8 KiB
Makefile
# 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)
|
|
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
|
|
|
|
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"
|
|
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
|
|
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".
|
|
.PHONY: help
|
|
help:
|
|
@( \
|
|
. ${VENV_DIR}/bin/activate; \
|
|
$(SPHINXBUILD) --help ;\
|
|
)
|
|
|
|
.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; \
|
|
)
|
|
|
|
.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: 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:
|
|
@make -C ${SCRIPTS_DIR} clean
|
|
|
|
.PHONY: build
|
|
build: docs
|