diff options
Diffstat (limited to 'docs/Makefile')
-rw-r--r-- | docs/Makefile | 88 |
1 files changed, 71 insertions, 17 deletions
diff --git a/docs/Makefile b/docs/Makefile index 49938640a34..ca4a3acdb9c 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -5,33 +5,46 @@ 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: help Makefile - -# Catch-all target: route all unknown targets to Sphinx using the new -# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). -%: Makefile -# Generate dynamic content - @python3 ./includes_renderer.py - @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) - -spell: +.PHONY: checkdeps +checkdeps: @echo "Checking whether dependencies for Docs are installed..." ifeq ($(OS_ID),ubuntu) @set -e; inst=; \ @@ -45,4 +58,45 @@ ifeq ($(OS_ID),ubuntu) else ifneq ("$(wildcard /etc/redhat-release)","") @sudo yum install $(CONFIRM) $(DOC_RPM_DEPENDS) endif - @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" -W -b spelling $(O) + +.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: build +build: docs + |